Oracle Vaults API

openapi: 3.2.0
info:
  description: Use the Secret Management API to manage secrets and secret versions. For more information, see [Managing Secrets](/Content/KeyManagement/Tasks/managingsecrets.htm).
  title: Vault Secret Management Vaults API
  version: '20180608'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/c0c869fc4c1c4efd44bf513113ce577a2785863654be723d8e57442a45bb0f9d.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Vault Secret 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/c0c869fc4c1c4efd44bf513113ce577a2785863654be723d8e57442a45bb0f9d.yaml
    what: the harvested document for Vault Secret Management API
servers:
- url: https://vaults.$region.oci.oraclecloud.com/20180608
tags:
- name: vaults
paths:
  /secrets:
    get:
      description: Lists all secrets in the specified vault and compartment.
      operationId: ListSecrets
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/FilterByNameQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/VaultIdQueryParam'
      - description: 'A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive.

          '
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/SecretSummary/lifecycleState'
        schema:
          type: string
      responses:
        '200':
          description: A list of secret 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 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#List_Pagination).

                '
              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/SecretSummary'
                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 all secrets.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets?compartmentId=<compartment_OCID>

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

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

        '
      x-obmcs-client-retries-enabled: true
    post:
      description: 'Creates a new secret according to the details of the request.


        This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

        '
      operationId: CreateSecret
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: The secret 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/Secret'
        '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 secret.
      tags:
      - vaults
      x-example: "POST /20180608/secrets\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"vaultId\": \"<var>&lt;vault_OCID&gt;</var>\",\n  \"secretRules\": \"[]\",\n  \"compartmentId\": \"\",\n  \"secretName\": \"testSecret\",\n  \"description\": \"my test secret\",\n  \"keyId\": \"<var>&lt;key_OCID&gt;</var>\",\n  \"secretContent\":\n    {\n      \"content\": \"<var>&lt;base64_encoded_secret_contents&gt;</var>\",\n      \"contentType\": \"BASE64\"\n    }\n}\n"
      x-obmcs-client-retries-enabled: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSecretDetails'
        description: Request to create a new secret.
        required: true
  /secrets/{secretId}:
    get:
      description: Gets information about the specified secret.
      operationId: GetSecret
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '200':
          description: The specified secret object.
          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/Secret'
        '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 secret.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets/<var>&lt;secret_OCID&gt;</var>

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

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

        '
      x-obmcs-client-retries-enabled: true
    put:
      description: 'Updates the properties of a secret. Specifically, you can update the version number of the secret to make

        that version number the current version. You can also update a secret''s description, its free-form or defined tags, rules

        and the secret contents. Updating the secret content automatically creates a new secret version. You cannot, however, update the current secret version number, secret contents, and secret rules at the

        same time. Furthermore, the secret must in an `ACTIVE` lifecycle state to be updated.


        This operation is not supported by the Oracle Cloud Infrastructure Terraform Provider.

        '
      operationId: UpdateSecret
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '200':
          description: The secret is being 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/Secret'
        '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 a secret's properties.
      tags:
      - vaults
      x-example: "PUT /20180608/secrets/<var>&lt;secret_OCID&gt;</var>\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"description\": \"updated version of my test secret\",\n  \"currentVersionNumber\": 4\n}\n"
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSecretDetails'
        description: Request to update a secret.
        required: true
  /secrets/{secretId}/actions/cancelDeletion:
    post:
      description: 'Cancels the pending deletion of the specified secret. Canceling

        a scheduled deletion restores the secret''s lifecycle state to what

        it was before you scheduled the secret for deletion.

        '
      operationId: CancelSecretDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The secret'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
        '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 a scheduled secret deletion.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/cancelDeletion

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

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

        '
      x-related-resource: '#/definitions/Secret'
  /secrets/{secretId}/actions/cancelRotation:
    post:
      description: "Cancels the ongoing secret rotation. The cancellation is contingent on how\nfar the rotation process has progressed. Upon cancelling a rotation, all \nfuture rotations are also disabled.\n"
      operationId: CancelSecretRotation
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The request to cancel the secret rotation was successful.
          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'
        '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 an ongoing secret rotation.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/cancelRotation

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

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

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Secret'
  /secrets/{secretId}/actions/changeCompartment:
    post:
      description: 'Moves a secret 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 secret.

        '
      operationId: ChangeSecretCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The compartment information for the secret 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 secret into a different compartment.
      tags:
      - vaults
      x-example: "POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/changeCompartment\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"<var>&lt;compartment_OCID&gt;</var>\"\n}\n"
      x-related-resource: '#/definitions/Secret'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeSecretCompartmentDetails'
        description: The updated compartment details.
        required: true
  /secrets/{secretId}/actions/rotate:
    post:
      description: 'API to force rotation of an existing secret in Vault and the specified target system; expects secret to have a valid Target System Details object

        '
      operationId: RotateSecret
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '202':
          description: The secret rotation request 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
            opc-work-request-id:
              description: 'The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.

                '
              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: Rotates an existing secret.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/rotate

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

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

        '
      x-obmcs-client-retries-enabled: true
      x-related-resource: '#/definitions/Secret'
  /secrets/{secretId}/actions/scheduleDeletion:
    post:
      description: 'Schedules the deletion of the specified secret. This sets the lifecycle state of the secret

        to `PENDING_DELETION` and then deletes it after the specified retention period ends.

        '
      operationId: ScheduleSecretDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      responses:
        '204':
          description: The secret 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
        '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 secret.
      tags:
      - vaults
      x-example: "POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/actions/scheduleDeletion\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2018-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/Secret'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSecretDeletionDetails'
        description: Request to schedule the deletion of a secret.
        required: true
  /secrets/{secretId}/version/{secretVersionNumber}:
    get:
      description: 'Gets information about the specified version of a secret.

        '
      operationId: GetSecretVersion
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam'
      responses:
        '200':
          description: The specified secret version object.
          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/SecretVersion'
        '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 secret version.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/version/<var>&lt;secret_version_number&gt;</var>

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

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

        '
      x-obmcs-client-retries-enabled: true
  /secrets/{secretId}/version/{secretVersionNumber}/actions/cancelDeletion:
    post:
      description: Cancels the scheduled deletion of a secret version.
      operationId: CancelSecretVersionDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam'
      responses:
        '204':
          description: The scheduled secret version 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
        '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 a scheduled secret version deletion.
      tags:
      - vaults
      x-example: 'POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/version/<var>&lt;secret_version_number&gt;</var>/actions/cancelDeletion

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

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

        '
      x-related-resource: '#/definitions/SecretVersion'
  /secrets/{secretId}/version/{secretVersionNumber}/actions/scheduleDeletion:
    post:
      description: 'Schedules the deletion of the specified secret version. This deletes it after the specified retention period ends. You can only

        delete a secret version if the secret version rotation state is marked as `DEPRECATED`.

        '
      operationId: ScheduleSecretVersionDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionNumberRequiredPathParam'
      responses:
        '204':
          description: The secret version 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
        '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 a deletion of a secret version.
      tags:
      - vaults
      x-example: "POST /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/version/<var>&lt;secret_version_number&gt;</var>/actions/scheduleDeletion\nHost: <var>&lt;managementEndpoint&gt;</var>\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2018-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/SecretVersion'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleSecretVersionDeletionDetails'
        description: 'Request to delete a secret version.

          '
        required: true
  /secrets/{secretId}/versions:
    get:
      description: Lists all secret versions for the specified secret.
      operationId: ListSecretVersions
      parameters:
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SecretIdRequiredPathParam'
      - $ref: '#/components/parameters/SecretVersionSortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: 'The secret version summary object for the specified secret.

            '
          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#List_Pagination).

                '
              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/SecretVersionSummary'
                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 all secret versions for a secret.
      tags:
      - vaults
      x-example: 'GET /20180608/secrets/<var>&lt;secret_OCID&gt;</var>/versions

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

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

        '
      x-obmcs-client-retries-enabled: true
components:
  schemas:
    RotationConfig:
      description: Defines the frequency of the rotation and the information about the target system
      properties:
        isScheduledRotationEnabled:
          description: 'Enables auto rotation, when set to true rotationInterval must be set.

            '
          type: boolean
        rotationInterval:
          description: 'The time interval that indicates the frequency for rotating secret data, as described in ISO 8601 format.

            The minimum value is 1 day and maximum value is 360 days.

            For example, if you want to set the time interval for rotating a secret data as 30 days, the duration is expressed as "P30D."

            '
          format: x-obmcs-duration
          type: string
        targetSystemDetails:
          $ref: '#/components/schemas/TargetSystemDetails'
      required:
      - targetSystemDetails
      type: object
    TargetSystemDetails:
      description: 'The TargetSystemDetails provides the targetSystem type and type-specific connection metadata

        '
      discriminator:
        propertyName: targetSystemType
      properties:
        targetSystemType:
          description: 'Unique identifier of the target system that Vault Secret connects to.

            '
          enum:
          - ADB
          - FUNCTION
          type: string
      required:
      - targetSystemType
      type: object
    SecretSummary:
      description: The details of the secret, excluding the contents of the secret.
      properties:
        compartmentId:
          description: The OCID of the compartment that contains the secret.
          type: string
        definedTags:
          additionalProperties:
            additionalProperties:
              description: 'An object that represents the value of the tag. Only string, integer, and Boolean types are 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
        description:
          description: A brief description of the secret.
          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
        id:
          description: The OCID of the secret.
          type: string
        isAutoGenerationEnabled:
          description: 'The value of this flag determines whether or not secret content will be generated automatically.

            '
          type: boolean
        keyId:
          description: 'The OCID of the master encryption key that is used to encrypt the secret. You must specify a symmetric key to encrypt the secret during import to the vault. You cannot encrypt secrets with asymmetric keys. Furthermore, the key must exist in the vault that you specify.

            '
          maxLength: 255
          type: string
        lastRotationTime:
          description: 'A property indicating when the secret was last rotated successfully, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

 

# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-vaults-api-openapi.yml