openapi: 3.2.0
info:
  description: 'Use the Key Management API to manage vaults and keys. For more information, see [Managing Vaults](/Content/KeyManagement/Tasks/managingvaults.htm) and [Managing Keys](/Content/KeyManagement/Tasks/managingkeys.htm).

    '
  license:
    name: Oracle Corporation
  title: Vault Key Management Kms Vault API
  version: release
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/6650b193f50d51919ae1a5f31b525097c777bb9e61575a82b12bf5a5fa5c1dea.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Vault Key Management 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/6650b193f50d51919ae1a5f31b525097c777bb9e61575a82b12bf5a5fa5c1dea.yaml
    what: the harvested document for Vault Key Management API
servers:
- url: /
tags:
- name: KmsVault
paths:
  /20180608/vaults/actions/restoreFromFile:
    post:
      description: 'Restores a vault from an encrypted backup file. If a vault

        with the same OCID already exists, this operation returns a response with a

        409 HTTP status error code.

        '
      operationId: RestoreVaultFromFile
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/ContentLengthHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/OptionalContentMD5Header'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RestoreVaultFromFileDetails'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '202':
          description: The vault has been restored.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-content-md5:
              description: 'The base64-encoded MD5 hash value of the request body, as computed

                by the server.

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

                a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                restore operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vault'
        '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/DefaultError'
      summary: Restores a vault from an encrypted backup file.
      tags:
      - KmsVault
      x-example: "POST /20180608/vaults/actions/restoreFromFile?compartmentId=<var>&lt;compartmentId&gt;</var>\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"RestoreVaultFromFileDetails\" : \"vault backup bytes..\"\n}\n"
      x-related-resource: '#/definitions/Vault'
  /20180608/vaults/actions/restoreFromObjectStore:
    post:
      description: 'Restores a vault from an encrypted backup file stored in Oracle Cloud Infrastructure Object

        Storage. If a vault with the same OCID already exists, this operation returns

        a response with a 409 HTTP status error code.

        '
      operationId: RestoreVaultFromObjectStore
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '202':
          description: The vault restore operation started successfully.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                restore operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vault'
        '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/DefaultError'
      summary: Restores a vault from an object storage location.
      tags:
      - KmsVault
      x-example: "POST /20180608/vaults/actions/restoreFromObjectStore?compartmentId=<var>&lt;compartmentId&gt;</var>\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"RestoreVaultFromObjectStoreDetails\" : {\n    \"backupLocation\" : {\n        \"BackupLocationURI\" : {\n            \"uri\" : \"http://n/namespace/b/bucket/o/object\"\n        }\n    }\n  }\n}\n"
      x-related-resource: '#/definitions/Vault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RestoreVaultFromObjectStoreDetails'
        description: RestoreVaultFromObjectStoreDetails
  /20180608/vaults/{vaultId}/actions/backup:
    post:
      description: 'Backs up an encrypted file that contains all the metadata of a vault so that you can restore the vault later.

        You can backup a vault whether or not it contains keys. This operation only backs up the

        metadata of the vault, and does not include key metadata.

        '
      operationId: BackupVault
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '202':
          description: The vault backup operation started successfully.
          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
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                backup operation.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vault'
        '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/DefaultError'
      summary: Backs up a vault.
      tags:
      - KmsVault
      x-example: "POST /20180608/vaults/<var>&lt;vault_OCID&gt;</var>/actions/backup\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"BackupVaultDetails\" : {\n    \"backupLocation\" : {\n        \"BackupLocationURI\" : {\n          \"uri\" : \"http://n/namespace/b/bucket/o/object\"\n        }\n    },\n    \"isIncludeKeys\" : false\n  }\n}\n"
      x-related-resource: '#/definitions/Vault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupVaultDetails'
        description: BackupVaultDetails
  /20180608/vaults/{vaultId}/usage:
    get:
      description: 'Gets the count of keys and key versions in the specified vault to calculate usage against service limits.

        '
      operationId: GetVaultUsage
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '200':
          description: The usage level of keys and key versions in the specified vault.
          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/VaultUsage'
        '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/DefaultError'
      summary: Gets the specified vault's usage against service limits.
      tags:
      - KmsVault
      x-example: 'GET /20180608/vaults/<var>&lt;vault_OCID&gt;</var>/usage

        Host: <var>&lt;managementEndpoint&gt;</var>

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

        '
  /20180608/vaults:
    get:
      description: 'Lists the vaults in the specified compartment.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning read operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        read operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: ListVaults
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: A list of vaults.
          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 there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

                [List Pagination](/Content/API/Concepts/usingapi.htm#nine).

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

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/VaultSummary'
                type: array
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Lists vaults in the compartment.
      tags:
      - KmsVault
      x-example: 'GET /20180608/vaults?compartmentId=<var>&lt;compartmentId&gt;</var>

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
    post:
      description: 'Creates a new vault. The type of vault you create determines key placement, pricing, and

        available options. Options include storage isolation, a dedicated service endpoint instead

        of a shared service endpoint for API calls, and either a dedicated hardware security module

        (HSM) or a multitenant HSM.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: CreateVault
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The vault is being created.
          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/Vault'
        '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/DefaultError'
      summary: Creates a new vault.
      tags:
      - KmsVault
      x-example: "POST /20180608/vaults\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5bsdea\",\n  \"displayName\": \"Vault 1\",\n  \"vaultType\": \"VIRTUAL_PRIVATE\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVaultDetails'
        description: CreateVaultDetails
        required: true
  /20180608/vaults/{vaultId}:
    get:
      description: 'Gets the specified vault''s configuration information.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning read operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        read operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: GetVault
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '200':
          description: The specified vault.
          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/Vault'
        '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/DefaultError'
      summary: Gets details about a vault.
      tags:
      - KmsVault
      x-example: 'GET /20180608/vaults/<var>&lt;vaultId&gt;</var>

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
    put:
      description: 'Updates the properties of a vault. Specifically, you can update the

        `displayName`, `freeformTags`, and `definedTags` properties. Furthermore,

        the vault must be in an ACTIVE or CREATING state to be updated.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: UpdateVault
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '200':
          description: The vault is updated according to the 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
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Vault'
        '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/DefaultError'
      summary: Updates the properties of a vault.
      tags:
      - KmsVault
      x-example: "PUT /20180608/vaults/<var>&lt;vaultId&gt;</var>\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"Vault 1\"\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateVaultDetails'
        description: UpdateVaultDetails
        required: true
  /20180608/vaults/{vaultId}/actions/cancelDeletion:
    post:
      description: 'Cancels the scheduled deletion of the specified vault. Canceling a scheduled deletion

        restores the vault and all keys in it to their respective states from before their

        scheduled deletion. All keys that were scheduled for deletion prior to vault

        deletion retain their lifecycle state and time of deletion.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: CancelVaultDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '200':
          description: The vault's scheduled deletion has been canceled.
          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/Vault'
        '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/DefaultError'
      summary: Cancels the scheduled deletion of a vault.
      tags:
      - KmsVault
      x-example: 'POST /20180608/vaults/<var>&lt;vaultId&gt;</var>/actions/cancelDeletion

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/Vault'
  /20180608/vaults/{vaultId}/actions/changeCompartment:
    post:
      description: 'Moves a vault into a different compartment within the same tenancy. For information about

        moving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).


        When provided, if-match is checked against the ETag values of the resource.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: ChangeVaultCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '204':
          description: The compartment information for the vault has been updated.
          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
        '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/DefaultError'
      summary: Moves a vault into a different compartment.
      tags:
      - KmsVault
      x-example: "POST /20180608/vaults/<var>&lt;vault_OCID&gt;</var>/actions/changeCompartment\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n}\n"
      x-related-resource: '#/definitions/Vault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeVaultCompartmentDetails'
        description: ChangeVaultCompartmentDetails
        required: true
  /20180608/vaults/{vaultId}/actions/createReplica:
    post:
      description: 'Creates a replica for the vault in another region in the same realm


        The API is a no-op if called for same region that a vault is already replicated to.

        409 if called on a vault that is already replicated to a different region. Users need to delete

        existing replica first before calling it with a different region.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: CreateVaultReplica
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '202':
          description: The vault replica is being created according to the 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 work request, used to track the progress of the

                create replica 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'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a replica for the vault in another region in the same realm
      tags:
      - KmsVault
      x-example: 'POST /20180608/vaults/<var>&lt;vault_OCID&gt;</var>/actions/createReplica

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/Vault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVaultReplicaDetails'
        description: CreateVaultReplicaDetails
        required: true
  /20180608/vaults/{vaultId}/actions/deleteReplica:
    post:
      description: 'Deletes a vault replica


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: DeleteVaultReplica
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '202':
          description: Vault replica delete request has been accepted successfully
          headers:
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

                a particular request, please provide the request ID.

                '
              schema:
                type: string
            opc-work-request-id:
              description: 'Unique Oracle-assigned identifier for the work request, used to track the progress of the

                delete replica 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'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Deletes a vault replica
      tags:
      - KmsVault
      x-example: 'POST /20180608/vaults/<var>&lt;vault_OCID&gt;</var>/actions/deleteReplica

        Host: kms.us-ashburn-1.oraclecloud.com

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

        {"region" : "us-ashburn-1"}

        '
      x-related-resource: '#/definitions/Vault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteVaultReplicaDetails'
        description: DeleteVaultReplicaDetails
        required: true
  /20180608/vaults/{vaultId}/actions/listReplicas:
    get:
      description: 'Lists the replicas for a vault


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: ListVaultReplicas
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '200':
          description: List of vault replicas
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                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 there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

                [List Pagination](/Content/API/Concepts/usingapi.htm#nine).

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

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/VaultReplicaSummary'
                type: array
        '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/DefaultError'
      summary: Lists the replicas for a vault
      tags:
      - KmsVault
      x-example: 'GET /20180608/vaults/<var>&lt;vault_OCID&gt;</var>/actions/listReplicas

        Host: kms.us-ashburn-1.oraclecloud.com

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

        '
      x-related-resource: '#/definitions/Vault'
  /20180608/vaults/{vaultId}/actions/scheduleDeletion:
    post:
      description: 'Schedules the deletion of the specified vault. This sets the lifecycle state of the vault and all keys in it

        that are not already scheduled for deletion to `PENDING_DELETION` and then deletes them after the

        retention period ends. The lifecycle state and time of deletion for keys already scheduled for deletion won''t

        change. If any keys in the vault are scheduled to be deleted after the specified time of

        deletion for the vault, the call is rejected with the error code 409.


        As a provisioning operation, this call is subject to a Key Management limit that applies to

        the total number of requests across all provisioning write operations. Key Management might

        throttle this call to reject an otherwise valid request when the total rate of provisioning

        write operations exceeds 10 requests per second for a given tenancy.

        '
      operationId: ScheduleVaultDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/VaultIdPathParam'
      responses:
        '200':
          description: The vault is scheduled for deletion.
          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/Vault'
        '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/DefaultError'
      summary: Schedules the deletion of a vault.
      tags:
      - KmsVault
      x-example: "POST /20180608/vaults/<var>&lt;vaultId&gt;</var>/actions/scheduleDeletion\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2018-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/Vault'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleVaultDeletionDetails'
        description: ScheduleVaultDeletionDetails
        required: true
components:
  schemas:
    ReplicaVaultMetadata:
      description: Metadata for the replica vault, needed if different from primary vault
      discriminator:
        propertyName: vaultType
      properties:
        vaultType:
          description: 'The type of vault. Each type of vault stores keys with different

            degrees of isolation and has different options and pricing.

            '
          enum:
          - EXTERNAL
          type: string
      required:
      - vaultType
    UpdateVaultDetails:
      description: The details of the Vault that you wish to update.
      properties:
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents the value of the tag. Only the string type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

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

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name for the vault. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          maxLength: 100
          minLength: 1
          type: string
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
      type: object
      x-example: "{\n  \"displayName\": \"Vault 1\",\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyFirstNamespace\":\n    {\n      \"CostCenter\": \"SmartAlec\",\n      \"Project\": \"42\",\n      \"CreatedBy\": \"SmartAlec\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n}\n"
    OauthMetadataSummary:
      description: Summary about authorization to be returned to the customer as a response.
      properties:
        clientAppId:
          description: ID of the client app created in IDP.
          maxLength: 255
          minLength: 1
          type: string
        idcsAccountNameUrl:
          description: Base URL of the IDCS account where confidential client app is created.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - idcsAccountNameUrl
      - clientAppId
      type: object
    ExternalKeyManagerMetadataSummary:
      description: Summary about metadata of external key manager to be returned to the customer as a response.
      properties:
        externalVaultEndpointUrl:
          description: URL of the vault on external key manager.
          maxLength: 255
          minLength: 1
          type: string
        oauthMetadataSummary:
          $ref: '#/components/schemas/OauthMetadataSummary'
        privateEndpointId:
          description: OCID of the private endpoint.
          maxLength: 255
          minLength: 1
          type: string
        vendor:
          description: Vendor of the external key manager.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - externalVaultEndpointUrl
      - privateEndpointId
      type: object
    Error:
      description: The desciption of Error message.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    VaultSummary:
      description: The details of the Vault.
      properties:
        compartmentId:
          description: The OCID of the compartment that contains a particular vault.
          maxLength: 255
          minLength: 1
          type: string
        cryptoEndpoint:
          description: 'The service endpoint to perform cryptographic operations against. Cryptographic operations include

            [Encrypt](/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](/api/#/en/key/latest/DecryptedData/Decrypt),

            and [GenerateDataEncryptionKey](/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations.

            '
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents the value of the tag. Only the string type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

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

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name for a vault. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          maxLength: 100
          minLength: 1
          type: string
        externalKeyManagerMetadataSummary:
          $ref: '#/components/schemas/ExternalKeyManagerMetadataSummary'
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The OCID of a vault.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'A vault''s current lifecycle state.


            Example: `ACTIVE`

            '
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - DELETED
          - PENDING_DELETION
          - SCHEDULING_DELETION
          - CANCELLING_DELETION
          - UPDATING
          - BACKUP_IN_PROGRESS
          - RESTORING
          type: string
        managementEndpoint:
          description: 'The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.

            '
          type: string
        timeCreated:
          description: 'The date and time a vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.


            Example: `2018-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        vaultType:
          description: 'The type of vault. Each type of vault stores keys with different

            degrees of isolation and has different options and pricing.

            '
          enum:
          - VIRTUAL_PRIVATE
          - EXTERNAL
          - DEFAULT
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - timeCreated
      - lifecycleState
      - vaultType
      - cryptoEndpoint
      - managementEndpoint
      type: object
      x-example: "[\n  {\n    \"compartmentId\": \"ocid1.tenancy.oc1..examplerti4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea\",\n    \"cryptoEndpoint\": \"https://exampleaaacu2-crypto.kms.us-ashburn-1.oraclecloud.com/\",\n    \"definedTags\": { },\n    \"displayName\": \"Vault 1\",\n    \"freeformTags\": { },\n    \"id\": \"ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbnqy7c7sqlywv25eajvnvcfauxpdgga6gct4a\",\n    \"lifecycleState\": \"ACTIVE\",\n    \"managementEndpoint\": \"https://exampleaaacu2-management.kms.us-ashburn-1.oraclecloud.com\",\n    \"timeCreated\": \"2018-04-03T20:35:12.023Z\",\n    \"vaultType\": \"VIRTUAL_PRIVATE\",\n    \"externalKeyManagerMetadataSummary\": {\n      \"oauthMetadataSummary\": {\n        \"idcsAccountNameUrl\": \"https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443\",\n        \"clientAppId\": \"2a2007581ad04d7293791457a3989d38\"\n      },\n      \"externalVaultEndpointUrl\": \"https://21.1.5.10/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7\",\n      \"privateEndpointId\": \"ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a\"\n    }\n  },\n  {\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lggneskcfy7lr4a6wfauxuwrwed5b3xea\",\n    \"cryptoEndpoint\": \"https://examplecaacu2-crypto.kms.us-ashburn-1.oraclecloud.com\",\n    \"definedTags\": { },\n    \"displayName\": \"Vault 0\",\n    \"freeformTags\": { },\n    \"id\": \"ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvb123jqy7c7sqlywv25eajvnvcfauxpdgga6gct4a\",\n    \"lifecycleState\": \"ACTIVE\",\n    \"managementEndpoint\": \"https://examplecaacu2-management.kms.us-ashburn-1.oraclecloud.com\",\n    \"timeCreated\": \"2018-04-03T18:20:50.352Z\",\n    \"vaultType\": \"VIRTUAL_PRIVATE\"\n    \"externalKeyManagerMetadata\": {\n      \"oauthMetadata\": {\n        \"idcsAccountNameUrl\": \"https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443\",\n        \"clientAppId\": \"2a2007581ad04d7293791457a3989d38\"\n      },\n      \"externalVaultEndpointUrl\": \"https://21.1.5.10/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7\",\n      \"privateEndpointId\": \"ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a\"\n    }\n  }\n]\n"
    VaultUsage:
      description: The details of the number of Keys and KeyVersions usage in a Vault.
      properties:
        keyCount:
          description: The number of keys in this vault that persist on a hardware security module (HSM), across all compartments, excluding keys in a `DELETED` state.
          format: int32
          minimum: 0
          type: integer
        keyVersionCount:
          description: The number of key versions in this vault that persist on a hardware security module (HSM), across all compartments, excluding key versions in a `DELETED` state.
          format: int32
          minimum: 0
          type: integer
        softwareKeyCount:
          description: The number of keys in this vault that persist on the server, across all compartments, excluding keys in a `DELETED` state.
          format: int32
          minimum: 0
          type: integer
        softwareKeyVersionCount:
          description: The number of key versions in this vault that persist on the server, across all compartments, excluding key versions in a `DELETED` state.
          format: int32
          minimum: 0
          type: integer
      required:
      - keyCount
      - keyVersionCount
      type: object
      x-example: "{\n  \"keyCount\": 3,\n  \"keyVersionCount\": 19,\n  \"softwareKeyCount\": 2,\n  \"softwareKeyVersionCount\": 4,\n}\n"
    ExternalKeyManagerMetadata:
      description: Metadata required for accessing External Key manager
      properties:
        externalVaultEndpointUrl:
          description: URI of the vault on external key manager.
          maxLength: 255
          minLength: 1
          type: string
        oauthMetadata:
          $ref: '#/components/schemas/OauthMetadata'
        privateEndpointId:
          description: OCID of private endpoint created by customer.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - oauthMetadata
      - externalVaultEndpointUrl
      - privateEndpointId
      type: object
    ScheduleVaultDeletionDetails:
      description: Details for scheduling vault deletion.
      properties:
        timeOfDeletion:
          description: 'An optional property indicating when to delete the vault, expressed in

            [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format. The specified

            time must be between 7 and 30 days from the time when the request is received.

            If this property is missing, it will be set to 30 days from the time of the request

            by default.

            '
          format: date-time
          type: string
      type: object
      x-example: "{\n  \"timeOfDeletion\": \"2018-04-03T21:10:29.600Z\"\n}\n"
    ChangeVaultCompartmentDetails:
      description: The details of the compartment you wish to move the Vault.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to move the vault to.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n}\n"
    BackupVaultDetails:
      description: The details of the Vault that you wish to backup.
      properties:
        backupLocation:
          $ref: '#/components/schemas/BackupLocation'
        isIncludeKeys:
          description: A Boolean value that indicates whether the Keys should be included during backing up the Vault.
          type: boolean
      type: object
      x-example: "{\n  \"backupLocation\" : {\n    \"BackupLocationURI\" : {\n      \"uri\" : \"http://n/namespace/b/bucket/o/object\"\n    }\n  },\n  \"isIncludeKeys\" : false\n}\n"
    Vault:
      description: The logical entity where the Vault service creates and durably stores keys.
      properties:
        compartmentId:
          description: The OCID of the compartment that contains this vault.
          maxLength: 255
          minLength: 1
          type: string
        cryptoEndpoint:
          description: 'The service endpoint to perform cryptographic operations against. Cryptographic operations include

            [Encrypt](/api/#/en/key/latest/EncryptedData/Encrypt), [Decrypt](/api/#/en/key/latest/DecryptedData/Decrypt),

            and [GenerateDataEncryptionKey](/api/#/en/key/latest/GeneratedKey/GenerateDataEncryptionKey) operations.

            '
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents the value of the tag. Only the string type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

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

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name for the vault. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          maxLength: 100
          minLength: 1
          type: string
        externalKeyManagerMetadataSummary:
          $ref: '#/components/schemas/ExternalKeyManagerMetadataSummary'
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        id:
          description: The OCID of the vault.
          maxLength: 255
          minLength: 1
          type: string
        isPrimary:
          description: A Boolean value that indicates whether the Vault is primary Vault or replica Vault.
          type: boolean
        lifecycleState:
          description: 'The vault''s current lifecycle state.


            Example: `DELETED`

            '
          enum:
          - CREATING
          - ACTIVE
          - DELETING
          - DELETED
          - PENDING_DELETION
          - SCHEDULING_DELETION
          - CANCELLING_DELETION
          - UPDATING
          - BACKUP_IN_PROGRESS
          - RESTORING
          type: string
        managementEndpoint:
          description: 'The service endpoint to perform management operations against. Management operations include "Create," "Update," "List," "Get," and "Delete" operations.

            '
          type: string
        replicaDetails:
          $ref: '#/components/schemas/VaultReplicaDetails'
        restoredFromVaultId:
          description: 'The OCID of the vault from which this vault was restored, if it was restored from a backup file.

            If you restore a vault to the same region, the vault retains the same OCID that it had when you

            backed up the vault.

            '
          type: string
        timeCreated:
          description: 'The date and time this vault was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.


            Example: `2018-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        timeOfDeletion:
          description: 'An optional property to indicate when to delete the vault, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            Example: `2018-04-03T21:10:29.600Z`

            '
          format: date-time
          type: string
        vaultType:
          description: 'The type of vault. Each type of vault stores the key with different

            degrees of isolation and has different options and pricing.

            '
          enum:
          - VIRTUAL_PRIVATE
          - DEFAULT
          - EXTERNAL
          type: string
        wrappingkeyId:
          description: The OCID of the vault's wrapping key.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - id
      - compartmentId
      - displayName
      - timeCreated
      - lifecycleState
      - vaultType
      - cryptoEndpoint
      - managementEndpoint
      - wrappingkeyId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wee6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5b3xea\",\n  \"cryptoEndpoint\": \"https://exampleaaacu2-crypto.kms.us-ashburn-1.oraclecloud.com\",\n  \"definedTags\": { },\n  \"displayName\": \"Vault 1\",\n  \"freeformTags\": { },\n  \"id\": \"ocid1.vault.oc1.iad.examplevaaeuk.examplehhv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a\",\n  \"lifecycleState\": \"ACTIVE\",\n  \"managementEndpoint\": \"https://exampleaaacu2-management.kms.us-ashburn-1.oraclecloud.com\",\n  \"timeCreated\": \"2018-04-03T20:35:12.023Z\",\n  \"timeOfDeletion\": \"2018-04-03T20:35:12.023Z\",\n  \"vaultType\": \"VIRTUAL_PRIVATE\",\n  \"restoredFromVaultId\": \"ocid1.vault.oc1.iad.examplevaaeuk.examplettv5i3qbkp22g3cvbjqy7c7sqlywv25eajvnvcfauxpdgga6gct4a\"\n  \"wrappingKeyId\": \"ocid1.key.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23kueityj4q2c6qfauxm32i577yu5a\",\n  \"replicaDetails\": {\"replicationId\" : \"12345abc\"}\n  \"isPrimary\": true\n  \"externalKeyManagerMetadataSummary\": {\n    \"oauthMetadataSummary\": {\n      \"idcsAccountNameUrl\": \"https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443\",\n      \"clientAppId\": \"6b50726c6a2b4118y1e56f4246878417\"\n    },\n    \"externalVaultEndpointUrl\": \"https://localhost/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7\",\n    \"privateEndpointId\": \"ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a\"\n  }\n}\n"
    CreateVaultReplicaDetails:
      description: Creates a vault replica.
      properties:
        replicaRegion:
          description: 'The region in the realm to which the vault need to be replicated to

            '
          maxLength: 255
          minLength: 1
          type: string
        replicaVaultMetadata:
          $ref: '#/components/schemas/ReplicaVaultMetadata'
      required:
      - replicaRegion
      type: object
      x-example: "{\n  \"replicaRegion\" : \"us-ashburn-1\"\n  \"replicaVaultMetadata\": {\n    \"vaultType\" : EXTERNAL,\n    \"privateEndpointId\": \"ocid1.privateendpoint.oc1.secondary-region.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a\",\n    \"idcsAccountNameUrl\": \"https://idcs-fb7a45fc4569481f88d675e213272f77.us-phoenix-idcs-3.identity.r1labiad1.c9dev1.oc9qadev.com\" \n    }\n}\n"
    VaultReplicaSummary:
      description: Summary of vault replicas
      properties:
        cryptoEndpoint:
          description: 'The vault replica''s crypto endpoint

            '
          type: string
        managementEndpoint:
          description: 'The vault replica''s management endpoint

            '
          type: string
        region:
          description: 'Region to which vault is replicated to

            '
          type: string
        status:
          description: Status of the Vault
          enum:
          - CREATING
          - CREATED
          - DELETING
          - DELETED
          type: string
      type: object
    BackupLocation:
      description: Backup upload location
      discriminator:
        propertyName: destination
      properties:
        destination:
          description: '''Backup location destination:

            BUCKET - Uploading or downloading backup via object store bucket

            PRE_AUTHENTICATED_REQUEST_URI - Uploading or downloading backup via a PreAuthenticated object store URI''

            '
          enum:
          - BUCKET
          - PRE_AUTHENTICATED_REQUEST_URI
          type: string
      required:
      - destination
    DeleteVaultReplicaDetails:
      description: Deletes a vault replica
      properties:
        replicaRegion:
          description: 'The region in the realm on which the replica should be deleted

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - replicaRegion
      type: object
      x-example: "{\n  \"replicaRegion\" : \"us-ashburn-1\"\n}\n"
    OauthMetadata:
      description: Authorization details required to get access token from IDP for accessing protected resources.
      properties:
        clientAppId:
          description: ID of the client app created in IDP.
          maxLength: 255
          minLength: 1
          type: string
        clientAppSecret:
          description: Secret of the client app created in IDP.
          format: password
          maxLength: 255
          minLength: 1
          type: string
        idcsAccountNameUrl:
          description: Base URL of the IDCS account where confidential client app is created.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - idcsAccountNameUrl
      - clientAppId
      - clientAppSecret
      type: object
    CreateVaultDetails:
      description: The details of the vault that you want to create.
      properties:
        compartmentId:
          description: The OCID of the compartment where you want to create this vault.
          maxLength: 255
          minLength: 1
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents the value of the tag. Only the string type is supported.

                '
              type: object
            description: 'Key-value pair representing a defined tag key and value, scoped to a namespace.

              Example: `{"CostCenter": "42"}`

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

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Operations": {"CostCenter": "42"}}`

            '
          type: object
        displayName:
          description: 'A user-friendly name for the vault. It does not have to be unique, and it is changeable.

            Avoid entering confidential information.

            '
          maxLength: 100
          minLength: 1
          type: string
        externalKeyManagerMetadata:
          $ref: '#/components/schemas/ExternalKeyManagerMetadata'
        freeformTags:
          additionalProperties:
            type: string
          description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

            For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).

            Example: `{"Department": "Finance"}`

            '
          type: object
        vaultType:
          description: 'The type of vault to create. Each type of vault stores the key with different degrees of isolation and has different options and pricing.

            '
          enum:
          - VIRTUAL_PRIVATE
          - DEFAULT
          - EXTERNAL
          type: string
      required:
      - compartmentId
      - displayName
      - vaultType
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4auufauxuwrwed5b3xea\",\n  \"displayName\": \"Vault 1\",\n  \"vaultType\": \"VIRTUAL_PRIVATE\",\n  \"freeformTags\": {\"Department\": \"Finance\"},\n  \"definedTags\":\n  {\n    \"MyFirstNamespace\":\n    {\n      \"CostCenter\": \"SmartAlec\",\n      \"Project\": \"42\",\n      \"CreatedBy\": \"SmartAlec\",\n      \"CreatedDate\": \"9/21/2017T14:00\"\n    },\n    \"Audit\":\n    {\n      \"DataSensitivity\": \"PII\",\n      \"CageSecurity\": \"High\",\n      \"Simplicity\": \"complex\"\n    }\n  }\n  \"externalKeyManagerMetadata\": {\n    \"oauthMetadata\":{\n      \"idcsAccountNameUrl\": \"https://idcs-fb7a45fc4569481f88d675e213272f77.identity.r1labiad1.c9dev1.oc9qadev.com:443\",\n      \"clientAppId\": \"6b50726c6c2b5118a1c56f4246878417\",\n      \"clientAppSecret\": \"7945ea13-d387-443a-ba67-66dc06a08923\"\n    },\n    \"externalVaultEndpointUrl\": \"https://localhost/api/v1/cckm/oci/external-vaults/37900289-47cf-4172-91c5-7ea6cb87c4b7\",\n    \"privateEndpointId\": \"ocid1.privateendpoint.oc1.iad.exampledaaeug.examplestkvmbjdnbickxcvbotxd5q23tteidhj4q2c6qfauxm32i577yu5a\"\n  }\n}\n"
    VaultReplicaDetails:
      description: 'Vault replica details

        '
      properties:
        replicationId:
          description: 'ReplicationId associated with a vault operation

            '
          maxLength: 255
          minLength: 1
          type: string
      type: object
    RestoreVaultFromObjectStoreDetails:
      description: The details of the backup location from which you want to restore the Vault.
      properties:
        backupLocation:
          $ref: '#/components/schemas/BackupLocation'
      type: object
      x-example: "{\n  \"backupLocation\" : {\n    \"BackupLocationURI\" : {\n      \"uri\" : \"http://n/namespace/b/bucket/o/object\"\n    }\n  },\n}\n"
  parameters:
    PaginationTokenQueryParam:
      description: 'The value of the `opc-next-page` response header

        from the previous "List" call.

        '
      in: query
      name: page
      required: false
      schema:
        type: string
        maxLength: 512
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can specify only one sort order. The default

        order for `TIMECREATED` is descending. The default order for `DISPLAYNAME`

        is ascending.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
    ContentLengthHeader:
      description: The content length of the body.
      in: header
      name: content-length
      required: true
      schema:
        type: integer
        format: int64
    CompartmentIdQueryParam:
      description: The OCID of the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a

        resource, set the `if-match` parameter to the value of the etag from a

        previous GET or POST response for that resource. The resource will be

        updated or deleted only if the etag you provide matches the resource''s

        current etag value.

        '
      in: header
      name: if-match
      required: false
      schema:
        type: string
    OptionalContentMD5Header:
      description: 'The base64-encoded MD5 hash value of the body, as described in [RFC 2616](https://tools.ietf.org/rfc/rfc2616), section 14.15.

        If the Content-MD5 header is present, Key Management performs an integrity check on the body of the HTTP request by computing the MD5

        hash for the body and comparing it to the MD5 hash supplied in the header. If the two hashes don''t match, the object is rejected and

        a response with 400 Unmatched Content MD5 error is returned, along with the message: "The computed MD5 of the request body (ACTUAL_MD5)

        does not match the Content-MD5 header (HEADER_MD5)."

        '
      in: header
      name: content-md5
      schema:
        type: string
    VaultIdPathParam:
      description: The OCID of the vault.
      in: path
      name: vaultId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return in a paginated "List" call.

        '
      in: query
      name: limit
      required: false
      schema:
        type: integer
        maximum: 1000
        minimum: 1
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`).

        '
      in: query
      name: sortOrder
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
    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 (e.g., if a resource has been

        deleted and purged from the system, then a retry of the original

        creation request may be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    RequestIdHeader:
      description: 'Unique identifier for the request. If provided, the returned request ID

        will include this value. Otherwise, a random request ID will be

        generated by the service.

        '
      in: header
      name: opc-request-id
      required: false
      schema:
        type: string
    RestoreVaultFromFileDetails:
      description: The encrypted backup file to upload to restore the vault.
      in: body
      name: RestoreVaultFromFileDetails
      required: true
      schema:
        format: binary
        type: string
  responses:
    DefaultError:
      description: An error has occurred.
      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'