openapi: 3.2.0
info:
  description: Use the Database Tools Runtime API to connect to databases through Database Tools Connections.
  title: Database Tools Runtime API
  version: '20230222'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/6813b69eeb0b14920a5a0d51829957383dfca32ea6f54edf4feba6d1eea66e56.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Database Tools Runtime API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/6813b69eeb0b14920a5a0d51829957383dfca32ea6f54edf4feba6d1eea66e56.yaml
    what: the harvested document for Database Tools Runtime API
servers:
- url: http://127.0.0.1/20230222
- url: https://127.0.0.1/20230222
tags:
- name: databaseToolsRuntime
paths:
  /databaseToolsConnections/{databaseToolsConnectionId}/actions/executeSql:
    post:
      description: 'Execute statements on a database tools connection.

        '
      operationId: ExecuteSqlDatabaseToolsConnection
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      responses:
        200:
          description: The script has been executed synchronously and the response contains the result
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteSqlResponse'
        202:
          description: The script statements are being executed asynchronously and the results can be monitored by polling the work request
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Execute statements on a database tools connection.
      tags:
      - databaseToolsRuntime
      x-example: "POST /...\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  ...\n}\n"
      x-related-resource: '#/definitions/DatabaseToolsConnection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExecuteSqlDatabaseToolsConnectionDetails'
        description: Script to execute on a DatabaseToolsConnection.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/actions/validateConnection:
    post:
      description: Validates the specified Database Tools connection.
      operationId: ValidateDatabaseToolsConnection
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      responses:
        200:
          description: The Database Tools connection validation details.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateDatabaseToolsConnectionResult'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Post DatabaseToolsConnectionValidate
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/DatabaseToolsConnection'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateDatabaseToolsConnectionDetails'
        description: Request to validate a DatabaseToolsConnection.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/credentials:
    get:
      description: Returns a paginated list of `CredentialSummary` for the specified request.
      operationId: ListCredentials
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: List of `CredentialSummary`.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: List credentials
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/Credential'
    post:
      description: Creates a credential for the user specified by the key.
      operationId: CreateCredential
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      responses:
        200:
          description: The credential information.
          headers:
            location:
              description: URI of the new resource which was created by the request.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a credential for the user specified by the key.
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/Credential'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialDetails'
        description: The payload to create credential.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}:
    delete:
      description: Delete credential
      operationId: DeleteCredential
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: Request has run successfully. The credential is deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Delete credential
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/Credential'
    get:
      description: Get a credential
      operationId: GetCredential
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      responses:
        200:
          description: The credential information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a credential
      tags:
      - databaseToolsRuntime
    put:
      description: Update a credential
      operationId: UpdateCredential
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      responses:
        200:
          description: The updated credential information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Credential'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Update a credential
      tags:
      - databaseToolsRuntime
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCredentialDetails'
        description: The information to be updated.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees:
    get:
      description: Get a list of all execute grantees
      operationId: ListCredentialExecuteGrantees
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: A page of `CredentialExecuteGranteeSummary` objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialExecuteGranteeCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a list of all execute grantees
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/CredentialExecuteGrantee'
    post:
      description: Grants the EXECUTE privilege on the credential to the user specified by the key.
      operationId: CreateCredentialExecuteGrantee
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      responses:
        200:
          description: Specifies the database user, the grantee, who is granted the execute privilege on the credential.
          headers:
            location:
              description: URI of the new resource which was created by the request.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialExecuteGrantee'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Grants the EXECUTE privilege on the credential to the user specified by the key.
      tags:
      - databaseToolsRuntime
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialExecuteGranteeDetails'
        description: The payload to create an execute grantee.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/executeGrantees/{executeGranteeKey}:
    delete:
      description: Delete execute grantee
      operationId: DeleteCredentialExecuteGrantee
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/CredentialExecuteGranteeKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: Request has run successfully. The execute grantee is deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Delete execute grantee
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/CredentialExecuteGrantee'
    get:
      description: Get a credential execute grantee
      operationId: GetCredentialExecuteGrantee
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/CredentialExecuteGranteeKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The execute grantee information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialExecuteGrantee'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a credential execute grantee
      tags:
      - databaseToolsRuntime
  /databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms:
    get:
      description: Get a list of all public synonyms for the given credential
      operationId: ListCredentialPublicSynonyms
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: A page of `CredentialPublicSynonymSummary` objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialPublicSynonymCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a list of all public synonyms for the given credential
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/CredentialPublicSynonym'
    post:
      description: Creates a public synonym for the given credentials
      operationId: CreateCredentialPublicSynonym
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      responses:
        200:
          description: The public synonym information
          headers:
            location:
              description: URI of the new resource which was created by the request.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialPublicSynonym'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Creates a public synonym for the given credentials
      tags:
      - databaseToolsRuntime
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCredentialPublicSynonymDetails'
        description: The payload to create a public synonym for the given credentials.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/credentials/{credentialKey}/publicSynonyms/{publicSynonymKey}:
    delete:
      description: Deletes the public synonym
      operationId: DeleteCredentialPublicSynonym
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/PublicSynonymKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        204:
          description: Request has run successfully. The public synonym is deleted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Delete a public synonym
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/CredentialPublicSynonym'
    get:
      description: Get a public synonym
      operationId: GetCredentialPublicSynonym
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      - $ref: '#/components/parameters/PublicSynonymKeyPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        200:
          description: The public synonym information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialPublicSynonym'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a public synonym
      tags:
      - databaseToolsRuntime
  /databaseToolsConnections/{databaseToolsConnectionId}/propertySets/{propertySetKey}:
    get:
      description: Get a property set
      operationId: GetPropertySet
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/PropertySetKeyPathParam'
      responses:
        200:
          description: The property set information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertySet'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a property set
      tags:
      - databaseToolsRuntime
    put:
      description: Update a property set
      operationId: UpdatePropertySet
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/PropertySetKeyPathParam'
      responses:
        200:
          description: The property set information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PropertySet'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        405:
          $ref: '#/components/responses/405'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Update a property set
      tags:
      - databaseToolsRuntime
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePropertySetDetails'
        description: The information to be updated.
        required: true
  /databaseToolsConnections/{databaseToolsConnectionId}/users/{userKey}/credentials:
    get:
      description: Returns a paginated list of user `UserCredentialSummary` for the specified request.
      operationId: ListUserCredentials
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/UserKeyPathParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: List of `UserCredentialSummary`.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCredentialCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: List user credentials
      tags:
      - databaseToolsRuntime
      x-related-resource: '#/definitions/UserCredential'
  /databaseToolsConnections/{databaseToolsConnectionId}/users/{userKey}/credentials/{credentialKey}:
    get:
      description: Get a user credential
      operationId: GetUserCredential
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsConnectionIdPathParam'
      - $ref: '#/components/parameters/UserKeyPathParam'
      - $ref: '#/components/parameters/CredentialKeyPathParam'
      responses:
        200:
          description: The user credential information
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserCredential'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Get a user credential
      tags:
      - databaseToolsRuntime
  /databaseToolsDatabaseApiGatewayConfigAdvancedProperties:
    get:
      description: Returns list of database API gateway config setting descriptions to be provided as advanced properties.
      operationId: ListDatabaseToolsDatabaseApiGatewayConfigAdvancedProperties
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: List of database API gateway config setting descriptions to be provided as advanced properties.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      tags:
      - databaseToolsRuntime
      x-example: "GET /20230222/databaseToolsDatabaseApiGatewayConfigAdvancedProperties HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  items: [{\n    \"key\": \"apex.security.administrator.roles\",\n    \"configTypes\": [ \"GLOBAL\", \"POOL\" ],\n    \"databaseToolsConnectionType\": \"ORACLE_DATABASE\",\n    \"displayName\": \"APEX Security Administrator Roles\",\n    \"documentationUrl\": \"https://docs.oracle.com/en/database/oracle/oracle-rest-data-services/latest/ordig/about-REST-configuration-files.html\",\n    \"description\": \"Specifies the comma delimited list of additional roles to assign authenticated APEX administrator type users\",\n    \"categoryKey\": \"APEX\",\n    \"categoryDisplayName\": \"Oracle APEX\",\n    \"defaultValue\": null,\n    \"minValue\": null,\n    \"maxValue\": null,\n    \"hintText\": \"Enter comma delimited list of roles.\",\n    \"dataType\": \"STRING\"\n  }]\n}\n"
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary'
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/content:
    get:
      description: Get the content of a Database Tools database API gateway config
      operationId: GetDatabaseToolsDatabaseApiGatewayConfigContent
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/IfNoneMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      responses:
        200:
          description: The Database Tools database API gateway config content
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                format: binary
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get the content of a Database Tools database API gateway config
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/content

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfig'
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/globals/{globalKey}:
    get:
      description: Get a Database Tools database API gateway config global resource
      operationId: GetDatabaseToolsDatabaseApiGatewayConfigGlobal
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigGlobalKeyPathParam'
      responses:
        200:
          description: The Database Tools database API gateway config global information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigGlobal'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a Database Tools database API gateway config global resource
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/globals/SETTINGS HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigGlobal'
    put:
      description: Update a Database Tools database API gateway config global resource
      operationId: UpdateDatabaseToolsDatabaseApiGatewayConfigGlobal
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigGlobalKeyPathParam'
      responses:
        200:
          description: The updated Database Tools database API gateway config global information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigGlobal'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a Database Tools database API gateway config global resource
      tags:
      - databaseToolsRuntime
      x-example: "PUT /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/globals/SETTINGS HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"databaseApi\": \"ENABLED\",\n  \"advancedProperties\": {\n    \"configRefreshInterval\": \"1h\"\n  }\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigGlobal'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails'
        description: The information to be updated.
        required: true
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools:
    get:
      description: Returns a list of Database Tools database API gateway config pool resources
      operationId: ListDatabaseToolsDatabaseApiGatewayConfigPools
      parameters:
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      responses:
        200:
          description: A page of Database Tools database API gateway config pool summary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Database Tools database API gateway config pool resources
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPool'
    post:
      description: Create a Database Tools database API gateway config pool resource
      operationId: CreateDatabaseToolsDatabaseApiGatewayConfigPool
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      responses:
        200:
          description: The created Database Tools database API gateway config pool information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URI of the new resource which was created by the request.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Create a Database Tools database API gateway config pool resource
      tags:
      - databaseToolsRuntime
      x-example: "POST /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"displayName\": \"APIs for HR database\",\n  \"databaseToolsConnectionId\": \"ocid1.databasetoolsconnection.oc1.phx.exampleaaaaaaaaaaaa\",\n  \"advancedProperties\" : {\n    \"misc.pagination.maxRows\" : \"100\"\n  }\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails'
        description: Details for the new Database Tools database API gateway config pool resource.
        required: true
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}:
    delete:
      description: Deletes the specified Database Tools database API gateway config pool resource.
      operationId: DeleteDatabaseToolsDatabaseApiGatewayConfigPool
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: Request to delete the Database Tools database API gateway config pool has been accepted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Database Tools database API gateway config pool resource.
      tags:
      - databaseToolsRuntime
      x-example: 'DELETE /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPool'
    get:
      description: Get a Database Tools database API gateway config pool resource
      operationId: GetDatabaseToolsDatabaseApiGatewayConfigPool
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      responses:
        200:
          description: The Database Tools database API gateway config pool information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a Database Tools database API gateway config pool resource
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPool'
    put:
      description: Update a Database Tools database API gateway config pool resource
      operationId: UpdateDatabaseToolsDatabaseApiGatewayConfigPool
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      responses:
        200:
          description: The updated Database Tools database API gateway config pool information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPool'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a Database Tools database API gateway config pool resource
      tags:
      - databaseToolsRuntime
      x-example: "PUT /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"displayName\": \"New Display Name\"\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPool'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails'
        description: The information to be updated.
        required: true
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs:
    get:
      description: Returns a list of Database Tools database API gateway config API spec resources
      operationId: ListDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecs
      parameters:
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      responses:
        200:
          description: A page of Database Tools database API gateway config API spec summary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Database Tools database API gateway config API spec resources
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/apiSpecs HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
    post:
      description: Create a Database Tools database API gateway config API spec resource
      operationId: CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      responses:
        200:
          description: The created Database Tools database API gateway config API spec information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URI of the new resource which was created by the request.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Create a Database Tools database API gateway config API spec resource
      tags:
      - databaseToolsRuntime
      x-example: "POST /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/apiSpecs HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"displayName\": \"Employees API\",\n  \"content\": \"{\\\"...\\\": \\\"...\\\"}\"\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails'
        description: Details for the new Database Tools database API gateway config API spec resource.
        required: true
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/apiSpecs/{apiSpecKey}:
    delete:
      description: Deletes the specified Database Tools database API gateway config API spec resource.
      operationId: DeleteDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigApiSpecKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: Request to delete the Database Tools database API gateway config API spec has been accepted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Database Tools database API gateway config API spec resource.
      tags:
      - databaseToolsRuntime
      x-example: 'DELETE /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/apiSpecs/<var>&lt;apiSpecKey&gt;</var>

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
    get:
      description: Get a Database Tools database API gateway config API spec resource
      operationId: GetDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigApiSpecKeyPathParam'
      responses:
        200:
          description: The Database Tools database API gateway config API spec information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a Database Tools database API gateway config API spec resource
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/apiSpecs/<var>&lt;apiSpecKey&gt;</var>

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
    put:
      description: Update a Database Tools database API gateway config API spec resource
      operationId: UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpec
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigApiSpecKeyPathParam'
      responses:
        200:
          description: The updated Database Tools database API gateway config API spec information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a Database Tools database API gateway config API spec resource
      tags:
      - databaseToolsRuntime
      x-example: "PUT /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/apiSpecs/<var>&lt;apiSpecKey&gt;</var>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"displayName\": \"New Display Name\",\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails'
        description: The information to be updated.
        required: true
  /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs:
    get:
      description: Returns a list of Database Tools database API gateway config auto API spec resources
      operationId: ListDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecs
      parameters:
      - $ref: '#/components/parameters/DisplayNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      responses:
        200:
          description: A page of Database Tools database API gateway config auto API spec summary objects.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Database Tools database API gateway config auto API spec resources
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/autoApiSpecs HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
    post:
      description: Create a Database Tools database API gateway config auto API spec resource
      operationId: CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      responses:
        200:
          description: The created Database Tools database API gateway config auto API spec information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            location:
              description: URI of the new resource which was created by the request.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Create a Database Tools database API gateway config auto API spec resource
      tags:
      - databaseToolsRuntime
      x-example: "POST /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/autoApiSpecs HTTP/1.1\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"displayName\": \"Employees Auto API\",\n  \"objectName\": \"EMPLOYEES\",\n  \"objectType\": \"TABLE\",\n  \"alias\": \"emp\",\n  \"operation\": [\"READ\"],\n  \"securitySchemes\": [\"BASIC\"]\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails'
        description: Details for the new Database Tools database API gateway config auto API spec resource.
        required: true
  ? /databaseToolsDatabaseApiGatewayConfigs/{databaseToolsDatabaseApiGatewayConfigId}/pools/{poolKey}/autoApiSpecs/{autoApiSpecKey}
  : delete:
      description: Deletes the specified Database Tools database API gateway config auto API spec resource.
      operationId: DeleteDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
      parameters:
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigAutoApiSpecKeyPathParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        204:
          description: Request to delete the Database Tools database API gateway config auto API spec has been accepted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Deletes a Database Tools database API gateway config auto API spec resource.
      tags:
      - databaseToolsRuntime
      x-example: 'DELETE /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/autoApiSpecs/<var>&lt;autoApiSpecKey&gt;</var>

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
    get:
      description: Get a Database Tools database API gateway config auto API spec resource
      operationId: GetDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigAutoApiSpecKeyPathParam'
      responses:
        200:
          description: The Database Tools database API gateway config auto API spec information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Get a Database Tools database API gateway config auto API spec resource
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/autoApiSpecs/<var>&lt;autoApiSpecKey&gt;</var>

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
    put:
      description: Update a Database Tools database API gateway config auto API spec resource
      operationId: UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigIdPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam'
      - $ref: '#/components/parameters/DatabaseToolsDatabaseApiGatewayConfigAutoApiSpecKeyPathParam'
      responses:
        200:
          description: The updated Database Tools database API gateway config auto API spec information
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Update a Database Tools database API gateway config auto API spec resource
      tags:
      - databaseToolsRuntime
      x-example: "PUT /20230222/databaseToolsDatabaseApiGatewayConfigs/<var>&lt;databaseToolsDatabaseApiGatewayConfigId&gt;</var>/pools/<var>&lt;poolKey&gt;</var>/autoApiSpecs/<var>&lt;autoApiSpecKey&gt;</var>\nHost: dbtools.us-phoenix-1.oci.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n\n{\n  \"type\": \"DEFAULT\",\n  \"displayName\": \"New Display Name\",\n}\n"
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails'
        description: The information to be updated.
        required: true
  /databaseToolsIdentities/{databaseToolsIdentityId}/actions/validateCredential:
    post:
      description: 'Validates the Database Tools identity credentials by establishing a connection to the customer database

        and executing the dbms_cloud.send_request to validate the credential.

        '
      operationId: ValidateDatabaseToolsIdentityCredential
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/DatabaseToolsIdentityIdPathParam'
      responses:
        200:
          description: The Database Tools identity credential validation details.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidateDatabaseToolsIdentityCredentialResult'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        409:
          $ref: '#/components/responses/409'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Validates a Database Tools identity credential.
      tags:
      - databaseToolsRuntime
      x-example: 'POST /20230222/databaseToolsIdentities/<var>&lt;databaseToolsIdentityId&gt;</var>/actions/validateCredential

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/DatabaseToolsIdentity'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ValidateDatabaseToolsIdentityCredentialDetails'
        description: Request to validate a Database Tools identity Credential.
        required: true
  /workRequests:
    get:
      description: 'Lists the work requests in a compartment.

        '
      operationId: ListWorkRequests
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ResourceIdentifierQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/WorkRequestSortByQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/OperationTypeQueryParam'
      - $ref: '#/components/parameters/CreatedByPrincipalIdQueryParam'
      - $ref: '#/components/parameters/WorkRequestStatusQueryParam'
      responses:
        200:
          description: The list is being retrieved.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: List Work Requests
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/workRequests?compartmentId=<var>&lt;compartmentId&gt;</var> HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
  /workRequests/{workRequestId}:
    delete:
      description: Attempts to cancel the specified work request.
      operationId: CancelWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      responses:
        202:
          description: Request to cancel work request is accepted.
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        503:
          $ref: '#/components/responses/503'
        default:
          $ref: '#/components/responses/default'
      summary: Attempts to cancel the specified work request
      tags:
      - databaseToolsRuntime
      x-example: 'DELETE /20230222/workRequests/<var>&lt;workRequestId&gt;</var> HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequest'
    get:
      description: Gets the status of the specified work request.
      operationId: GetWorkRequest
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      responses:
        200:
          description: The detail of the work request.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
            retry-after:
              description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
              schema:
                type: number
                format: float
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequest'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: GET Work Request Status
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/workRequests/<var>&lt;workRequestId&gt;</var> HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
  /workRequests/{workRequestId}/errors:
    get:
      description: 'Returns a paginated list of errors for the specified work request.

        '
      operationId: ListWorkRequestErrors
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request errors.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestErrorCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists work request errors
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/workRequests/<var>&lt;workRequestId&gt;</var>/errors HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequestError'
  /workRequests/{workRequestId}/logs:
    get:
      description: 'Returns a paginated list of logs for the specified work request.

        '
      operationId: ListWorkRequestLogs
      parameters:
      - $ref: '#/components/parameters/WorkRequestIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      responses:
        200:
          description: List of work request logs.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then a partial list might have been returned. Include this value as the `page` parameter for the

                subsequent GET request to get the next batch of items.

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkRequestLogEntryCollection'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/default'
      summary: Lists work request logs
      tags:
      - databaseToolsRuntime
      x-example: 'GET /20230222/workRequests/<var>&lt;workRequestId&gt;</var>/logs HTTP/1.1

        Host: dbtools.us-phoenix-1.oci.oraclecloud.com

        <var>&lt;authorization and other headers&gt;</var>

        '
      x-related-resource: '#/definitions/WorkRequestLogEntry'
components:
  schemas:
    ExecuteSqlOutputDispositionDetails:
      description: Describes how the response of a command is to be stored
      discriminator:
        propertyName: type
      properties:
        type:
          description: The location resource type.
          enum:
          - OBJECT_STORAGE
          type: string
      required:
      - type
      type: object
    Error:
      description: Error Information.
      properties:
        code:
          description: A short error code that defines the error, meant for programmatic parsing.
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecCollection:
      description: List of Database Tools database API gateway config auto API spec summary items.
      properties:
        items:
          description: Array of Database Tools database API gateway config auto API spec summary items.
          items:
            $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSummary'
          type: array
      required:
      - items
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecSummary:
      description: Summary of the Database Tools database API gateway config API spec resource.
      discriminator:
        propertyName: type
      properties:
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: A system generated string that uniquely identifies an API spec sub resource within a pool.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - displayName
      - timeCreated
      - timeUpdated
      type: object
    CreateDatabaseToolsDatabaseApiGatewayConfigPoolDetails:
      description: The content of a Database Tools database API gateway config pool sub resource to be created.
      discriminator:
        propertyName: type
      properties:
        advancedProperties:
          additionalProperties:
            type: string
          description: Advanced pool properties.
          type: object
        databaseActionsStatus:
          default: DISABLED
          description: Specifies to enable the Database Actions feature.
          enum:
          - ENABLED
          - DISABLED
          type: string
        databaseToolsConnectionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        initialPoolSize:
          default: 0
          description: Specifies the initial size for the number of database connections that will be created for the pool.
          maximum: 100000
          minimum: 0
          type: integer
        jwtProfileAudience:
          description: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileIssuer:
          description: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileJwkUrl:
          description: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileRoleClaimName:
          description: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
          maxLength: 4000
          minLength: 0
          type: string
        maxPoolSize:
          default: 100
          description: Specifies the maximum number of database connections allowed for the pool.
          maximum: 100000
          minimum: 1
          type: integer
        minPoolSize:
          default: 0
          description: Specifies the minimum number of database connections allowed for the pool.
          maximum: 1000
          minimum: 0
          type: integer
        poolRouteValue:
          description: The pool route value provided in requests to target this pool.
          maxLength: 255
          minLength: 1
          type: string
        restEnabledSqlStatus:
          default: DISABLED
          description: Specifies whether the REST-Enabled SQL service is active.
          enum:
          - ENABLED
          - DISABLED
          type: string
        type:
          description: The type of the Database Tools database API gateway config pool sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      - displayName
      - databaseToolsConnectionId
      - poolRouteValue
      type: object
    CreateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails:
      description: The content of a Database Tools database API gateway config auto API spec sub resource to be created.
      discriminator:
        propertyName: type
      properties:
        alias:
          description: Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
          maxLength: 255
          minLength: 0
          type: string
        databaseObjectName:
          description: The name of the database object.
          maxLength: 255
          minLength: 1
          type: string
        databaseObjectType:
          description: The type of the database object.
          enum:
          - FUNCTION
          - MVIEW
          - PACKAGE
          - PROCEDURE
          - TABLE
          - VIEW
          - DUALITYVIEW
          type: string
        description:
          description: Description of the autoApiSpec.
          maxLength: 4000
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        operations:
          description: The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
          items:
            enum:
            - READ
            - WRITE
            type: string
          maxItems: 2
          minItems: 0
          type: array
        roles:
          description: The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 20
          minItems: 0
          type: array
        scope:
          description: The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
          maxLength: 255
          minLength: 0
          type: string
        securitySchemes:
          description: The security schemes that can access this resource. If not specified then the resource is public.
          items:
            enum:
            - BASIC
            - BEARER
            type: string
          maxItems: 2
          minItems: 0
          type: array
        type:
          description: The type of the Database Tools database API gateway config auto API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      - displayName
      - databaseObjectName
      - databaseObjectType
      type: object
    CreateCredentialExecuteGranteeDetails:
      description: Specifies the database user, the grantee, who is granted the execute privilege on the credential.
      properties:
        key:
          description: The name of the user to grant the EXECUTE privilege on the credential.
          maxLength: 128
          minLength: 1
          type: string
          x-obmcs-cli-param: execute-grantee-key
      required:
      - key
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpec:
      description: The content of a Database Tools database API gateway config auto API spec sub resource defined within a pool.
      discriminator:
        propertyName: type
      properties:
        alias:
          description: Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
          maxLength: 255
          minLength: 0
          type: string
        databaseObjectName:
          description: The name of the database object.
          maxLength: 255
          minLength: 1
          type: string
        databaseObjectType:
          description: The type of the database object.
          enum:
          - FUNCTION
          - MVIEW
          - PACKAGE
          - PROCEDURE
          - TABLE
          - VIEW
          - DUALITYVIEW
          type: string
        description:
          description: Description of the autoApiSpec.
          maxLength: 4000
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: A system generated string that uniquely identifies an auto API spec sub resource within a given pool.
          maxLength: 255
          minLength: 1
          type: string
        operations:
          description: The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
          items:
            enum:
            - READ
            - WRITE
            type: string
          maxItems: 2
          minItems: 0
          type: array
        roles:
          description: The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 20
          minItems: 0
          type: array
        scope:
          description: The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
          maxLength: 255
          minLength: 0
          type: string
        securitySchemes:
          description: The security schemes that can access this resource. If not specified then the resource is public.
          items:
            enum:
            - BASIC
            - BEARER
            type: string
          maxItems: 2
          minItems: 0
          type: array
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config auto API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - displayName
      - timeCreated
      - timeUpdated
      type: object
    ExecuteSqlDatabaseToolsConnectionDetails:
      description: A request
      discriminator:
        propertyName: type
      properties:
        output:
          $ref: '#/components/schemas/ExecuteSqlOutputDetails'
        type:
          description: The request execution type.
          enum:
          - SYNCHRONOUS
          - ASYNCHRONOUS
          type: string
      required:
      - type
      type: object
    WorkRequestSummary:
      description: A summary of the status of a work request.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
          maxLength: 255
          minLength: 1
          type: string
        createdByPrincipalDomainId:
          description: Identity domain OCID for the user that submitted the asynchronous request.
          maxLength: 255
          minLength: 1
          type: string
        createdByPrincipalId:
          description: Principal id of the user or resource that submitted the asynchrounous request.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: 'A user-friendly name for the operation.

            If provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation''s progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.

            '
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
          maxLength: 255
          minLength: 1
          type: string
        operationType:
          description: The asynchronous operation tracked by this work request.
          enum:
          - EXECUTE_SQL
          - EXECUTE_SQL_SCHEDULED_DELETION
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: The status of the work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          - WAITING
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: The date and time the work request was created, in the format defined by RFC3339.
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.

            Format is defined by RFC3339.

            '
          format: date-time
          type: string
        timeScheduled:
          description: 'The date and time the work request is eligible to be launched,

            in the format defined by RFC3339.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,

            in the format defined by RFC3339.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the work request was last updated,

            in the format defined by RFC3339.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - percentComplete
      - timeAccepted
    DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary:
      description: Description of a database API gateway config setting to be provided as an advanced property.
      properties:
        categoryDisplayName:
          description: A user-friendly name of a category.
          maxLength: 255
          minLength: 1
          type: string
        categoryKey:
          description: The category of the Database Tools database API gateway config global setting.
          maxLength: 255
          minLength: 1
          type: string
        configTypes:
          description: 'The config types that support this advanced property. The supported types are GLOBAL and POOL.

            '
          items:
            enum:
            - GLOBAL
            - POOL
            type: string
            x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigAdvancedPropertyConfigType'
          type: array
        dataType:
          description: The data type of a database API gateway config setting.
          enum:
          - STRING
          - NUMBER
          - DURATION
          - BOOLEAN
          type: string
        databaseToolsConnectionTypes:
          description: "The type of database (as determined by a type of Database Tools connection) to which this setting applies. \nThe advancedProperty applies to all types of Database Tools connection when null. This is only applicable\nwhen configTypes includes POOL.\n"
          items:
            enum:
            - ORACLE_DATABASE
            - MYSQL
            type: string
          type: array
        defaultValue:
          description: The default value (if applicable) of a database API gateway config setting.
          maxLength: 255
          minLength: 1
          type: string
        description:
          description: A user-friendly description of a database API gateway config setting.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A user-friendly name.
          maxLength: 255
          minLength: 1
          type: string
        documentationUrl:
          description: Uniform resource locator (URL) of documentation related to this setting.
          maxLength: 255
          minLength: 1
          type: string
        hintText:
          description: Hint text for a database API gateway config setting.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: A string that uniquely identifies a Database Tools database API gateway config global settings resource.
          maxLength: 255
          minLength: 1
          type: string
        listOfValues:
          description: A list of string values (if applicable) supported by this database API gateway config setting.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 100
          minItems: 0
          type: array
        maxValue:
          description: A maximum numeric value (if applicable) of a database API gateway config setting.
          type: integer
        minValue:
          description: A minimum numeric value (if applicable) of a database API gateway config setting.
          type: integer
      required:
      - key
      - displayName
      - dataType
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPool:
      description: The content of a Database Tools database API gateway config pool sub resource.
      discriminator:
        propertyName: type
      properties:
        advancedProperties:
          additionalProperties:
            type: string
          description: Advanced pool properties.
          type: object
        databaseActionsStatus:
          default: DISABLED
          description: Specifies to enable the Database Actions feature.
          enum:
          - ENABLED
          - DISABLED
          type: string
        databaseToolsConnectionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        initialPoolSize:
          default: 0
          description: Specifies the initial size for the number of database connections that will be created for the pool.
          maximum: 100000
          minimum: 0
          type: integer
        jwtProfileAudience:
          description: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileIssuer:
          description: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileJwkUrl:
          description: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileRoleClaimName:
          description: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
          maxLength: 4000
          minLength: 0
          type: string
        key:
          description: A system generated string that uniquely identifies a pool sub resource.
          maxLength: 255
          minLength: 1
          type: string
        maxPoolSize:
          default: 100
          description: Specifies the maximum number of database connections allowed for the pool.
          maximum: 100000
          minimum: 1
          type: integer
        minPoolSize:
          default: 0
          description: Specifies the minimum number of database connections allowed for the pool.
          maximum: 1000
          minimum: 0
          type: integer
        poolRouteValue:
          description: The pool route value provided in requests to target this pool.
          maxLength: 255
          minLength: 1
          type: string
        restEnabledSqlStatus:
          default: DISABLED
          description: Specifies whether the REST-Enabled SQL service is active.
          enum:
          - ENABLED
          - DISABLED
          type: string
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config pool sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - timeCreated
      - timeUpdated
      type: object
    UpdateDatabaseToolsDatabaseApiGatewayConfigGlobalDetails:
      description: The content of the Database Tools database API gateway config global sub resource to be updated.
      discriminator:
        propertyName: type
      properties:
        advancedProperties:
          additionalProperties:
            type: string
          description: Advanced global properties.
          type: object
        certificateBundle:
          $ref: '#/components/schemas/DatabaseApiGatewayConfigCertificateBundle'
        databaseApiStatus:
          description: ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.
          enum:
          - ENABLED
          - DISABLED
          type: string
        documentRoot:
          description: The location of the static resources to be served under the / root server path.
          maxLength: 4096
          minLength: 0
          type: string
        httpPort:
          description: Specifies the HTTP listen port. 0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended.
          maximum: 65535
          minimum: 0
          type: integer
        httpsPort:
          description: Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.
          maximum: 65535
          minimum: 0
          type: integer
        poolRoute:
          description: How the target pool route value is determined for a HTTP request.
          enum:
          - PATH
          - HEADER
          type: string
        poolRoutingHeader:
          description: The request header name providing the pool route value.
          maxLength: 255
          minLength: 0
          type: string
        type:
          description: The type of the Database Tools database API gateway config global settings resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      type: object
    UserCredentialCollection:
      description: List of `UserCredentialSummary` items.
      properties:
        items:
          description: Array of `UserCredentialSummary` items.
          items:
            $ref: '#/components/schemas/UserCredentialSummary'
          type: array
      required:
      - items
      type: object
    CredentialPublicSynonymSummary:
      description: The public synonym information
      properties:
        key:
          description: The name of the public synonym for the credential
          maxLength: 128
          minLength: 1
          type: string
      required:
      - key
      type: object
    UpdateDatabaseToolsDatabaseApiGatewayConfigPoolDetails:
      description: The content of a Database Tools database API gateway config pool sub resource to be updated.
      discriminator:
        propertyName: type
      properties:
        advancedProperties:
          additionalProperties:
            type: string
          description: Advanced pool properties.
          type: object
        databaseActionsStatus:
          default: DISABLED
          description: Specifies to enable the Database Actions feature.
          enum:
          - ENABLED
          - DISABLED
          type: string
        databaseToolsConnectionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection. Specifies the OCI database tools connection ocid to build the connection pool from.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        initialPoolSize:
          default: 0
          description: Specifies the initial size for the number of database connections that will be created for the pool.
          maximum: 100000
          minimum: 0
          type: integer
        jwtProfileAudience:
          description: Specifies the expected audience for the JWT token. This value is used to validate the aud claim in the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileIssuer:
          description: Specifies the issuer of the JWT token. This value is used to validate the iss claim in the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileJwkUrl:
          description: Specifies the URL of the JSON Web Key (JWK) that is used to verify the signature of the JWT token.
          maxLength: 4000
          minLength: 0
          type: string
        jwtProfileRoleClaimName:
          description: Specifies the JSON pointer to the claim in the JWT token that contains the roles of the users.
          maxLength: 4000
          minLength: 0
          type: string
        maxPoolSize:
          default: 100
          description: Specifies the maximum number of database connections allowed for the pool.
          maximum: 100000
          minimum: 1
          type: integer
        minPoolSize:
          default: 0
          description: Specifies the minimum number of database connections allowed for the pool.
          maximum: 1000
          minimum: 0
          type: integer
        poolRouteValue:
          description: The pool route value provided in requests to target this pool.
          maxLength: 255
          minLength: 1
          type: string
        restEnabledSqlStatus:
          default: DISABLED
          description: Specifies whether the REST-Enabled SQL service is active.
          enum:
          - ENABLED
          - DISABLED
          type: string
        type:
          description: The type of the Database Tools database API gateway config pool sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      type: object
    UserCredentialSummary:
      description: User Credential information
      properties:
        enabled:
          description: Indicates whether this credential is enabled (TRUE) or not (FALSE)
          type: string
        key:
          description: Name of the credential
          type: string
        keyType:
          description: Indicates whether this refers to a public synonym or not.
          enum:
          - CREDENTIAL_NAME
          - PUBLIC_SYNONYM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialKeyType'
        owner:
          description: Owner of the credential
          type: string
        relatedResource:
          $ref: '#/components/schemas/CredentialRelatedResource'
        userName:
          description: Name of the user that will be used to log in to the remote database or the remote or local operating system
          type: string
        windowsDomain:
          description: For a Windows target, the Windows domain to use when logging in
          type: string
      required:
      - key
      - userName
      - enabled
      - owner
      type: object
    PropertySet:
      description: The base definition for a property set
      discriminator:
        propertyName: key
      properties:
        isMutable:
          description: Indicates whether the property set is mutable or not
          type: boolean
        key:
          description: The name of the property set
          enum:
          - APEX_DOCUMENT_GENERATOR
          - APEX
          - APEX_FA_INTEGRATION
          - ORACLE_DATABASE_EXTERNAL_AUTHENTICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/PropertySetKey'
      required:
      - key
      - isMutable
      type: object
    ValidateDatabaseToolsConnectionDetails:
      description: Connection validation details.
      discriminator:
        propertyName: type
      properties:
        type:
          description: The `DatabaseToolsConnection` type.
          enum:
          - ORACLE_DATABASE
          - MYSQL
          - POSTGRESQL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
      required:
      - type
      type: object
    DatabaseToolsDatabaseApiGatewayConfigGlobal:
      description: The content of a Database Tools database API gateway config global resource.
      discriminator:
        propertyName: type
      properties:
        advancedProperties:
          additionalProperties:
            type: string
          description: Advanced global properties.
          type: object
        certificateBundle:
          $ref: '#/components/schemas/DatabaseApiGatewayConfigCertificateBundle'
        databaseApiStatus:
          default: ENABLED
          description: ORDS database API is a database management and monitoring REST API. Database Actions requires this feature.
          enum:
          - ENABLED
          - DISABLED
          type: string
        documentRoot:
          description: The location of the static resources to be served under the / root server path.
          maxLength: 4096
          minLength: 0
          type: string
        httpPort:
          default: 0
          description: Specifies the HTTP listen port. 0 disables HTTP. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended.
          maximum: 65535
          minimum: 0
          type: integer
        httpsPort:
          default: 8443
          description: Specifies the HTTPS listen port. 0 disables HTTPS. Use of ports below 1024 requires elevated (root) privileges and is generally discouraged; deployment on non-privileged ports (1024–65535) is recommended. ORDS will use a self-signed certificate if a certificate bundle is not provided.
          maximum: 65535
          minimum: 0
          type: integer
        key:
          description: A string that uniquely identifies a Database Tools database API gateway config global settings resource.
          maxLength: 255
          minLength: 1
          type: string
        metadataSource:
          description: The RESTful service definition location.
          enum:
          - DATABASE
          - CLOUD
          type: string
        poolRoute:
          default: PATH
          description: How the target pool route value is determined for a HTTP request.
          enum:
          - PATH
          - HEADER
          type: string
        poolRoutingHeader:
          description: The request header name providing the pool route value.
          maxLength: 255
          minLength: 0
          type: string
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config global settings resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - timeCreated
      - timeUpdated
      type: object
    UpdatePropertySetDetails:
      description: The base definition for a property set update
      discriminator:
        propertyName: key
      properties:
        key:
          description: The name of the property set
          enum:
          - APEX_DOCUMENT_GENERATOR
          - APEX
          - APEX_FA_INTEGRATION
          - ORACLE_DATABASE_EXTERNAL_AUTHENTICATION
          type: string
          x-obmcs-top-level-enum: '#/definitions/PropertySetKey'
      required:
      - key
      type: object
    ExecuteSqlOutputDetails:
      description: Defines how the script result should be stored
      discriminator:
        propertyName: type
      properties:
        resultDispositionTemplates:
          description: "Defines how the result of commands in a script should be stored. \nIf the command does not match any template filter, the result will be inline.\n"
          items:
            $ref: '#/components/schemas/ExecuteSqlOutputResultDispositionTemplate'
          type: array
        type:
          description: The response disposition type.
          enum:
          - OBJECT_STORAGE
          type: string
      required:
      - type
      type: object
    CredentialExecuteGranteeSummary:
      description: Specifies the database user, the grantee, who is granted the execute privilege on the credential.
      properties:
        key:
          description: The name of the user to grant the EXECUTE privilege on the credential.
          maxLength: 128
          minLength: 1
          type: string
      required:
      - key
      type: object
    UserCredential:
      description: Credential information
      properties:
        enabled:
          description: Indicates whether this credential is enabled (TRUE) or not (FALSE)
          type: string
        key:
          description: Name of the credential
          type: string
        keyType:
          description: Indicates whether this refers to a public synonym or not.
          enum:
          - CREDENTIAL_NAME
          - PUBLIC_SYNONYM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialKeyType'
        owner:
          description: Owner of the credential
          type: string
        relatedResource:
          $ref: '#/components/schemas/CredentialRelatedResource'
        userName:
          description: Name of the user that will be used to log in to the remote database or the remote or local operating system
          type: string
        windowsDomain:
          description: For a Windows target, the Windows domain to use when logging in
          type: string
      required:
      - key
      - userName
      - enabled
      - owner
      type: object
    ValidateDatabaseToolsIdentityCredentialDetails:
      description: Identity Credential validation details.
      discriminator:
        propertyName: type
      properties:
        type:
          description: The Database Tools identity type.
          enum:
          - ORACLE_DATABASE_RESOURCE_PRINCIPAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/IdentityType'
      required:
      - type
      type: object
    CredentialPublicSynonymCollection:
      description: List of `CredentialPublicSynonymSummary` items.
      properties:
        items:
          description: Array of `CredentialPublicSynonymSummary` items.
          items:
            $ref: '#/components/schemas/CredentialPublicSynonymSummary'
          type: array
      required:
      - items
      type: object
    CredentialExecuteGrantee:
      description: Specifies the database user, the grantee, who is granted the execute privilege on the credential.
      properties:
        key:
          description: The name of the user to grant the EXECUTE privilege on the credential.
          maxLength: 128
          minLength: 1
          type: string
      required:
      - key
      type: object
    CredentialPublicSynonym:
      description: The public synonym information
      properties:
        key:
          description: The name of the public synonym for the credential
          maxLength: 128
          minLength: 1
          type: string
      required:
      - key
      type: object
    WorkRequestLogEntry:
      description: A log message from the execution of a work request.
      properties:
        message:
          description: Human-readable log message.
          type: string
        timestamp:
          description: The time the log message was written. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - message
      - timestamp
    WorkRequest:
      description: An asynchronous work request.
      properties:
        compartmentId:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the work request.
          maxLength: 255
          minLength: 1
          type: string
        createdByPrincipalDomainId:
          description: Identity domain OCID for the user that submitted the asynchronous request.
          maxLength: 255
          minLength: 1
          type: string
        createdByPrincipalId:
          description: Principal id of the user or resource that submitted the asynchrounous request.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: "A user-friendly name for the operation. \nIf provided for an asynchronous operation, this value will be propagated to the displayName property of the resulting Work Request, allowing for easier identification and tracking of the operation's progress and outcome. This name is purely for descriptive purposes and does not affect the functionality of the operation itself.\n"
          maxLength: 255
          minLength: 1
          type: string
        id:
          description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the work request.
          maxLength: 255
          minLength: 1
          type: string
        operationType:
          description: The asynchronous operation tracked by this work request.
          enum:
          - EXECUTE_SQL
          - EXECUTE_SQL_SCHEDULED_DELETION
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
        percentComplete:
          description: Percentage of the request completed.
          format: float
          type: number
        resources:
          description: The resources affected by this work request.
          items:
            $ref: '#/components/schemas/WorkRequestResource'
          type: array
        status:
          description: The status of the work request.
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          - WAITING
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
        timeAccepted:
          description: The date and time the work request was created, in the format defined by RFC3339.
          format: date-time
          type: string
        timeFinished:
          description: 'The date and time the work request reached a terminal state, either `FAILED` or `SUCCEEDED`.

            Format is defined by RFC3339.

            '
          format: date-time
          type: string
        timeScheduled:
          description: 'The date and time the work request is eligible to be launched,

            in the format defined by RFC3339.

            '
          format: date-time
          type: string
        timeStarted:
          description: 'The date and time the work request transitioned from `ACCEPTED` to `IN_PROGRESS`,

            in the format defined by RFC3339.

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the work request was last updated,

            in the format defined by RFC3339.

            '
          format: date-time
          type: string
      required:
      - operationType
      - status
      - id
      - compartmentId
      - resources
      - percentComplete
      - timeAccepted
    CredentialRelatedResource:
      description: A related resource for a credential.
      properties:
        identifier:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related resource.
          type: string
        type:
          description: The related resource type.
          enum:
          - DATABASE_TOOLS_IDENTITY
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialRelatedResourceType'
      required:
      - type
      - identifier
      type: object
    WorkRequestCollection:
      description: List of `WorkRequestSummary` items.
      properties:
        items:
          description: Array of `WorkRequestSummary` items.
          items:
            $ref: '#/components/schemas/WorkRequestSummary'
          type: array
      required:
      - items
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolApiSpec:
      description: The content of a Database Tools database API gateway config API spec sub resource defined within a pool.
      discriminator:
        propertyName: type
      properties:
        content:
          description: The content of a string-escaped Open API spec in JSON format.
          maxLength: 102400
          minLength: 2
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: A system generated string that uniquely identifies an API spec sub resource within a given pool.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - displayName
      - content
      - timeCreated
      - timeUpdated
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolSummary:
      description: Summary of the Database Tools database API gateway config pool resource.
      discriminator:
        propertyName: type
      properties:
        databaseToolsConnectionId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the related Database Tools connection.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: A system generated string that uniquely identifies a pool sub resource.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config pool sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - displayName
      - databaseToolsConnectionId
      - timeCreated
      - timeUpdated
      type: object
    CredentialCollection:
      description: List of `CredentialSummary` items.
      properties:
        items:
          description: Array of `CredentialSummary` items.
          items:
            $ref: '#/components/schemas/CredentialSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestResource:
      description: A resource created or operated on by a work request.
      properties:
        actionType:
          description: 'The way in which this resource is affected by the work tracked in the work request.

            A resource being created, updated, or deleted will remain in the IN_PROGRESS state until

            work is complete for that resource at which point it will transition to CREATED, UPDATED,

            or DELETED, respectively.

            '
          enum:
          - CREATED
          - UPDATED
          - DELETED
          - IN_PROGRESS
          - RELATED
          - FAILED
          - CANCELED
          type: string
          x-obmcs-top-level-enum: '#/definitions/ActionType'
        entityType:
          description: The resource type the work request affects.
          type: string
        entityUri:
          description: The URI path that the user can use for a GET operation to access the resource metadata.
          type: string
        identifier:
          description: The identifier of the resource the work request affects.
          type: string
        metadata:
          additionalProperties:
            description: 'Key-value pair representing Object Storage namespace, bucketName, and/or objectName.

              Example: `{"bucketName": "myBucket", "namespace": "myNamespace", "objectName": "myObject"}`

              '
            type: string
          description: Additional information explaining the resource.
          type: object
      required:
      - actionType
      - entityType
      - identifier
    UpdateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails:
      description: The content of a Database Tools database API gateway config API spec sub resource to be updated.
      discriminator:
        propertyName: type
      properties:
        content:
          description: The content of a string-escaped Open API spec in JSON format.
          maxLength: 102400
          minLength: 2
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        type:
          description: The type of the Database Tools database API gateway config API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      type: object
    Credential:
      description: Credential information
      properties:
        enabled:
          description: Indicates whether this credential is enabled (TRUE) or not (FALSE)
          type: string
        key:
          description: Name of the credential
          type: string
        keyType:
          description: Indicates whether this refers to a public synonym or not.
          enum:
          - CREDENTIAL_NAME
          - PUBLIC_SYNONYM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialKeyType'
        owner:
          description: Owner of the credential
          type: string
        relatedResource:
          $ref: '#/components/schemas/CredentialRelatedResource'
        userName:
          description: Name of the user that will be used to log in to the remote database or the remote or local operating system
          type: string
        windowsDomain:
          description: For a Windows target, the Windows domain to use when logging in
          type: string
      required:
      - key
      - userName
      - enabled
      - owner
      type: object
    CreateCredentialDetails:
      description: Details for the new credential.
      discriminator:
        propertyName: type
      properties:
        key:
          description: The credential_name to be created
          maxLength: 255
          minLength: 1
          type: string
          x-obmcs-cli-param: credential-key
        type:
          description: The type of credential.
          enum:
          - BASIC
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialType'
      required:
      - type
      - key
      type: object
    ExecuteSqlOutputResultDispositionTemplate:
      description: Template defining how the result of a command should be stored.
      properties:
        objectTemplate:
          $ref: '#/components/schemas/ExecuteSqlOutputDispositionDetails'
        statementType:
          description: Commands matching this statement type will use this result disposition.
          enum:
          - QUERY
          - DML
          - DDL
          - PLSQL
          - SQLPLUS
          - IGNORE
          - TRANSACTION_CONTROL
          - SESSION_CONTROL
          - SYSTEM_CONTROL
          - JDBC
          - OTHER
          type: string
          x-obmcs-top-level-enum: '#/definitions/StatementType'
      required:
      - statementType
      - objectTemplate
      type: object
    WorkRequestError:
      description: An error encountered while executing a work request.
      properties:
        code:
          description: 'A machine-usable code for the error that occured. Error codes are listed on

            (https://docs.cloud.oracle.com/Content/API/References/apierrors.htm)

            '
          type: string
        message:
          description: A human readable description of the issue encountered.
          type: string
        timestamp:
          description: The time the error occured. An RFC3339 formatted datetime string.
          format: date-time
          type: string
      required:
      - code
      - message
      - timestamp
    DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummaryCollection:
      description: List of database API gateway config setting descriptions to be provided as advanced properties.
      properties:
        items:
          description: List of database API gateway config setting descriptions to be provided as advanced properties.
          items:
            $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigAdvancedPropertySummary'
          type: array
      required:
      - items
      type: object
    CredentialExecuteGranteeCollection:
      description: List of `CredentialExecuteGranteeSummary` items.
      properties:
        items:
          description: Array of `CredentialExecuteGranteeSummary` items.
          items:
            $ref: '#/components/schemas/CredentialExecuteGranteeSummary'
          type: array
      required:
      - items
      type: object
    DatabaseApiGatewayConfigCertificateBundle:
      description: The certificate bundle that describes the SSL certicicate. Ignored if the httpsPort is 0.
      discriminator:
        propertyName: type
      properties:
        type:
          description: The type of the certificate.
          enum:
          - FILENAME
          - SELF_SIGNED
          type: string
      required:
      - type
      type: object
    UpdateCredentialDetails:
      description: Credential information to be updated.
      discriminator:
        propertyName: type
      properties:
        type:
          description: The type of credential.
          enum:
          - BASIC
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialType'
      required:
      - type
      type: object
    ValidateDatabaseToolsConnectionResult:
      description: Connection validation result.
      discriminator:
        propertyName: type
      properties:
        action:
          description: A human-readable message that suggests a remedial action to resolve the validation error.
          type: string
        cause:
          description: A human-readable message that describes possible causes for the validation error.
          type: string
        code:
          description: A short code that defines the result of the validation, meant for programmatic parsing. The value OK indicates that the validation was successful.
          type: string
        message:
          description: A human-readable message that describes the result of the validation.
          type: string
        type:
          description: The Database Tools connection type.
          enum:
          - ORACLE_DATABASE
          - MYSQL
          - POSTGRESQL
          type: string
          x-obmcs-top-level-enum: '#/definitions/ConnectionType'
      required:
      - type
      - code
      - message
      type: object
    ValidateDatabaseToolsIdentityCredentialResult:
      description: Identity validation result.
      discriminator:
        propertyName: type
      properties:
        action:
          description: A human-readable message that suggests a remedial action to resolve the validation error.
          type: string
        cause:
          description: A human-readable message that describes possible causes for the validation error.
          type: string
        code:
          description: A short code that defines the result of the validation, meant for programmatic parsing. The value OK indicates that the validation was successful.
          type: string
        message:
          description: A human-readable message that describes the result of the validation.
          type: string
        type:
          description: The Database Tools identity type.
          enum:
          - ORACLE_DATABASE_RESOURCE_PRINCIPAL
          type: string
          x-obmcs-top-level-enum: '#/definitions/IdentityType'
      required:
      - type
      - code
      - message
      type: object
    CreateDatabaseToolsDatabaseApiGatewayConfigPoolApiSpecDetails:
      description: The content of a Database Tools database API gateway config API spec sub resource to be created.
      discriminator:
        propertyName: type
      properties:
        content:
          description: The content of a string-escaped Open API spec in JSON format.
          maxLength: 102400
          minLength: 2
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        type:
          description: The type of the Database Tools database API gateway config API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      - displayName
      - content
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolCollection:
      description: List of Database Tools database API gateway config pool summary items.
      properties:
        items:
          description: Array of Database Tools database API gateway config pool summary items.
          items:
            $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolSummary'
          type: array
      required:
      - items
      type: object
    ExecuteSqlResponse:
      description: Contains the details for the SQL statements to execute on the database connection.
      discriminator:
        propertyName: type
      properties:
        env:
          $ref: '#/components/schemas/ExecuteSqlResponseEnv'
        type:
          description: The response payload type
          enum:
          - STANDARD
          - BATCH
          - SCRIPT
          type: string
          x-obmcs-top-level-enum: '#/definitions/PayloadType'
        version:
          description: Script version
          type: string
      required:
      - type
      type: object
    CreateCredentialPublicSynonymDetails:
      description: The public synonym information
      properties:
        key:
          description: The name of the public synonym for the credential
          maxLength: 128
          minLength: 1
          type: string
          x-obmcs-cli-param: public-synonym-key
      required:
      - key
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecSummary:
      description: Summary of the Database Tools database API gateway config auto API spec resource.
      discriminator:
        propertyName: type
      properties:
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        key:
          description: A system generated string that uniquely identifies an auto API spec sub resource within a pool.
          maxLength: 255
          minLength: 1
          type: string
        timeCreated:
          description: The time the resource was created. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        timeUpdated:
          description: The time the resource was updated. An RFC3339 formatted datetime string.
          format: date-time
          type: string
        type:
          description: The type of the Database Tools database API gateway config auto API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - key
      - type
      - displayName
      - timeCreated
      - timeUpdated
      type: object
    DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecCollection:
      description: List of Database Tools database API gateway config API spec summary items.
      properties:
        items:
          description: Array of Database Tools database API gateway config API spec summary items.
          items:
            $ref: '#/components/schemas/DatabaseToolsDatabaseApiGatewayConfigPoolApiSpecSummary'
          type: array
      required:
      - items
      type: object
    WorkRequestErrorCollection:
      description: List of WorkRequestError items.
      properties:
        items:
          description: Array of Work Request Error items.
          items:
            $ref: '#/components/schemas/WorkRequestError'
          type: array
      required:
      - items
      type: object
    UpdateDatabaseToolsDatabaseApiGatewayConfigPoolAutoApiSpecDetails:
      description: The content of a Database Tools database API gateway config auto API spec sub resource to be updated.
      discriminator:
        propertyName: type
      properties:
        alias:
          description: Used as the URI path element for this object. When not specified the objectName lowercase is the default value.
          maxLength: 255
          minLength: 0
          type: string
        databaseObjectName:
          description: The name of the database object.
          maxLength: 255
          minLength: 1
          type: string
        databaseObjectType:
          description: The type of the database object.
          enum:
          - FUNCTION
          - MVIEW
          - PACKAGE
          - PROCEDURE
          - TABLE
          - VIEW
          - DUALITYVIEW
          type: string
        description:
          description: Description of the autoApiSpec.
          maxLength: 4000
          minLength: 0
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique, and it’s changeable. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        operations:
          description: The operations to limit access to this resource. If not specified then the default is ["READ","WRITE"].
          items:
            enum:
            - READ
            - WRITE
            type: string
          maxItems: 2
          minItems: 0
          type: array
        roles:
          description: The name of the database API gateway config roles protecting the resource. Only valid for RBAC JWT Profile pools and BEARER securitySchemes.
          items:
            maxLength: 255
            minLength: 1
            type: string
          maxItems: 20
          minItems: 0
          type: array
        scope:
          description: The name of the database API gateway config privilege protecting the resource. Only valid for SCOPE JWT Profile pools and BEARER securitySchemes.
          maxLength: 255
          minLength: 0
          type: string
        securitySchemes:
          description: The security schemes that can access this resource. If not specified then the resource is public.
          items:
            enum:
            - BASIC
            - BEARER
            type: string
          maxItems: 2
          minItems: 0
          type: array
        type:
          description: The type of the Database Tools database API gateway config auto API spec sub resource.
          enum:
          - DEFAULT
          type: string
          x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigType'
      required:
      - type
      type: object
    CredentialSummary:
      description: Credential information
      properties:
        enabled:
          description: Indicates whether this credential is enabled (TRUE) or not (FALSE)
          type: string
        key:
          description: Name of the credential
          type: string
        keyType:
          description: Indicates whether this refers to a public synonym or not.
          enum:
          - CREDENTIAL_NAME
          - PUBLIC_SYNONYM
          type: string
          x-obmcs-top-level-enum: '#/definitions/CredentialKeyType'
        owner:
          description: Owner of the credential
          type: string
        relatedResource:
          $ref: '#/components/schemas/CredentialRelatedResource'
        userName:
          description: Name of the user that will be used to log in to the remote database or the remote or local operating system
          type: string
        windowsDomain:
          description: For a Windows target, the Windows domain to use when logging in
          type: string
      required:
      - key
      - userName
      - enabled
      - owner
      type: object
    ExecuteSqlResponseEnv:
      description: Database session environment.
      properties:
        defaultTimeZone:
          description: The database default time zone.
          format: x-obmcs-time-zone
          type: string
      required:
      - defaultTimeZone
      type: object
    WorkRequestLogEntryCollection:
      description: List of work request log items.
      properties:
        items:
          description: Array of work request log items.
          items:
            $ref: '#/components/schemas/WorkRequestLogEntry'
          type: array
      required:
      - items
      type: object
  parameters:
    CreatedByPrincipalIdQueryParam:
      description: A filter to return only work requests initiated by the specified principal OCID.
      in: query
      name: createdByPrincipalId
      schema:
        type: string
    DatabaseToolsDatabaseApiGatewayConfigPoolKeyPathParam:
      description: The key of the pool config.
      in: path
      name: poolKey
      required: true
      schema:
        type: string
    IfNoneMatchHeader:
      description: 'For conditional requests. In the GET call for a resource, set the

        `If-None-Match` header to the value of the ETag from a previous GET (or

        POST or PUT) response for that resource. The server will return with

        either a 304 Not Modified response if the resource has not changed, or a

        200 OK response with the updated representation.

        '
      in: header
      name: if-none-match
      required: false
      x-default-description: 'null'
      schema:
        type: string
    IfMatchHeader:
      description: "If-Match is most often used with state-changing methods (e.g., POST, PUT, DELETE) to prevent \naccidental overwrites when multiple user agentss might be acting in parallel on the same \nresource (i.e., to prevent the \"lost update\" problem). In general, it can be used with any \nmethod that involves the selection or modification of a representation to abort the request \nif the selected representation's current entity tag is not a member within the If-Match field value.  \nWhen specified on an action-specific subresource, the ETag value of the resource on which the \naction is requested should be provided.\n"
      in: header
      name: if-match
      required: false
      schema:
        type: string
    SortOrderQueryParam:
      description: The sort order to use, either 'asc' or 'desc'.
      in: query
      name: sortOrder
      x-obmcs-top-level-enum: '#/definitions/SortOrder'
      schema:
        type: string
        enum:
        - ASC
        - DESC
        default: ASC
    PublicSynonymKeyPathParam:
      description: The name of the public synonym for the credential
      in: path
      name: publicSynonymKey
      required: true
      schema:
        type: string
    RequestIdHeader:
      description: The client request ID for tracing.
      in: header
      name: opc-request-id
      schema:
        type: string
    PropertySetKeyPathParam:
      description: The name of the property set
      in: path
      name: propertySetKey
      required: true
      x-obmcs-top-level-enum: '#/definitions/PropertySetKey'
      schema:
        type: string
        enum:
        - APEX_DOCUMENT_GENERATOR
        - APEX
        - APEX_FA_INTEGRATION
        - ORACLE_DATABASE_EXTERNAL_AUTHENTICATION
    SortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeCreated
        - displayName
        default: timeCreated
    ResourceIdentifierQueryParam:
      description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the resource.
      in: query
      name: resourceIdentifier
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    DatabaseToolsConnectionIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools connection.
      in: path
      name: databaseToolsConnectionId
      required: true
      x-obmcs-cli-param: connection-id
      schema:
        type: string
    WorkRequestStatusQueryParam:
      description: A filter to return only work requests with one of the specified status values.
      in: query
      name: status
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - FAILED
          - SUCCEEDED
          - CANCELING
          - CANCELED
          - WAITING
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationStatus'
    OperationTypeQueryParam:
      description: The work request operation type.
      in: query
      name: operationType
      required: false
      x-default-description: 'null'
      style: form
      explode: true
      schema:
        type: array
        items:
          enum:
          - EXECUTE_SQL
          - EXECUTE_SQL_SCHEDULED_DELETION
          type: string
          x-obmcs-top-level-enum: '#/definitions/OperationType'
    WorkRequestIdPathParam:
      description: The ID of the asynchronous request.
      in: path
      name: workRequestId
      required: true
      schema:
        type: string
    DatabaseToolsDatabaseApiGatewayConfigApiSpecKeyPathParam:
      description: The key of the API spec config.
      in: path
      name: apiSpecKey
      required: true
      schema:
        type: string
    CredentialKeyPathParam:
      description: The name of the credential
      in: path
      name: credentialKey
      required: true
      schema:
        type: string
    DisplayNameQueryParam:
      description: A filter to return only resources that match the entire specified display name.
      in: query
      name: displayName
      x-default-description: 'null'
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationTokenQueryParam:
      description: The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
      in: query
      name: page
      schema:
        type: string
        minLength: 1
    UserKeyPathParam:
      description: The name of the database user.
      in: path
      name: userKey
      required: true
      schema:
        type: string
    DatabaseToolsDatabaseApiGatewayConfigGlobalKeyPathParam:
      description: The key of the global config.
      in: path
      name: globalKey
      required: true
      x-obmcs-top-level-enum: '#/definitions/DatabaseApiGatewayConfigGlobalKey'
      schema:
        type: string
        enum:
        - SETTINGS
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations. For example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        might be rejected.


        Accepted characters: ASCII alphanumerics plus underscore (U+005F LOW LINE "_") and dash (U+002D HYPHEN-MINUS "-")

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
        pattern: ^[a-zA-Z0-9_\-]{1,64}$
    CredentialExecuteGranteeKeyPathParam:
      description: The name of the user granted the EXECUTE privilege on the credential.
      in: path
      name: executeGranteeKey
      required: true
      schema:
        type: string
    WorkRequestSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Default order for timeAccepted is descending. If no value is specified timeAccepted is default.

        '
      in: query
      name: sortBy
      schema:
        type: string
        enum:
        - timeAccepted
        - timeUpdated
        - timeFinished
        default: timeAccepted
    DatabaseToolsIdentityIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools identity.
      in: path
      name: databaseToolsIdentityId
      required: true
      x-obmcs-cli-param: identity-id
      schema:
        type: string
    CompartmentIdQueryParam:
      description: The ID of the compartment in which to list resources.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
    PaginationLimitQueryParam:
      description: The maximum number of items to return.
      in: query
      name: limit
      schema:
        type: integer
        default: 10
        maximum: 1000
        minimum: 1
    DatabaseToolsDatabaseApiGatewayConfigAutoApiSpecKeyPathParam:
      description: The key of the auto API spec config.
      in: path
      name: autoApiSpecKey
      required: true
      schema:
        type: string
    DatabaseToolsDatabaseApiGatewayConfigIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of a Database Tools database API gateway config.
      in: path
      name: databaseToolsDatabaseApiGatewayConfigId
      required: true
      x-obmcs-cli-param: database-api-gateway-config-id
      schema:
        type: string
  responses:
    default:
      description: Unknown Error
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    location:
      description: URI of the new resource which was created by the request.
      type: string
    opc-next-page:
      description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

        then a partial list might have been returned. Include this value as the `page` parameter for the

        subsequent GET request to get the next batch of items.

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
    opc-work-request-id:
      description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.

        '
      type: string
    retry-after:
      description: A decimal number representing the number of seconds the client should wait before polling this endpoint again.
      format: float
      type: number
  x-properties:
    definedTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace.

        Example: `{"foo-namespace": {"bar-key": "value"}}`

        '
      type: object
    freeformTags:
      additionalProperties:
        type: string
      description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.

        Example: `{"bar-key": "value"}`

        '
      type: object
    systemTags:
      additionalProperties:
        additionalProperties:
          description: 'The value of the tag. Only string, integer and boolean types are supported.

            '
          type: object
        description: 'Key-value pair representing system tags'' keys and values scoped to a namespace.

          Example: `{"bar-key": "value"}`

          '
        type: object
      description: 'Usage of system tag keys. These predefined keys are scoped to namespaces.

        Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`

        '
      type: object
x-obmcs-client-retries-enabled: true
x-oracle-package: com.oracle.pic.dbtools.runtime