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.

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

            '
          format: date-time
          type: string
        lifecycleDetails:
          description: Additional information about the secret's current lifecycle state.
          maxLength: 4000
          minLength: 1
          type: string
        lifecycleState:
          description: The current lifecycle state of the secret.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - SCHEDULING_DELETION
          - PENDING_DELETION
          - CANCELLING_DELETION
          - FAILED
          type: string
        nextRotationTime:
          description: 'A property indicating when the secret is scheduled to be rotated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
        rotationConfig:
          $ref: '#/components/schemas/RotationConfig'
        rotationStatus:
          description: Additional information about the status of the secret rotation
          type: string
          x-obmcs-enumref: '#/definitions/Secret/rotationStatus'
        secretGenerationContext:
          $ref: '#/components/schemas/SecretGenerationContext'
        secretName:
          description: The name of the secret.
          maxLength: 255
          type: string
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

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

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

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


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

            '
          type: object
        timeCreated:
          description: 'A property indicating when the secret was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
        timeOfCurrentVersionExpiry:
          description: 'An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

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

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

            '
          format: date-time
          type: string
        vaultId:
          description: The OCID of the Vault in which the secret exists
          type: string
      required:
      - id
      - vaultId
      - secretName
      - compartmentId
      - lifecycleState
      - timeCreated
      type: object
      x-example: "[\n  {\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample\",\n    \"definedTags\": { },\n    \"description\": null,\n    \"freeformTags\": {},\n    \"systemTags\": {},\n    \"keyId\": \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example\",\n    \"id\": \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqahuecvbjqzql4qmpbrtd7pprafhivcfik6wuitexample\",\n    \"lifecycleDetails\": null,\n    \"lifecycleState\": \"ACTIVE\",\n    \"secretName\": \"testsecret\",\n    \"timeCreated\": \"2020-03-17T20:34:07.147Z\",\n    \"timeOfCurrentVersionExpiry\": null,\n    \"timeOfDeletion\": null,\n    \"vaultId\": \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\"\n  },\n  {\n    \"compartmentId\": \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbnionqvhvsudmlpe557wakiofexample\",\n    \"definedTags\": { },\n    \"description\": \"example secret\",\n    \"freeformTags\": { },\n    \"systemTags\": {},\n    \"keyId\": \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example\",\n    \"id\": \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wcvbrqmw5dnyzvcxwzds6er5enn2oamexample\",\n    \"lifecycleDetails\": null,\n    \"lifecycleState\": \"ACTIVE\",\n    \"secretName\": \"examplesecret\",\n    \"timeCreated\": \"2020-03-18T16:51:38.851Z\",\n    \"timeOfCurrentVersionExpiry\": \"2020-04-18T16:51:39.442Z\",\n    \"timeOfDeletion\": null,\n    \"vaultId\": \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\"\n  }\n  ,{\n    \"compartmentId\" : \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample\",\n    \"currentVersionNumber\" : 1,\n    \"definedTags\" : { },\n    \"description\" : \"example secret description\",\n    \"freeformTags\" : { },\n    \"systemTags\": {},\n    \"id\" : \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample”,\n    \"keyId\" : \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example”,\n    \"lifecycleDetails\" : null,\n    \"lifecycleState\" : \"ACTIVE\",\n    \"metadata\" : null,\n    \"secretName\" : \"exampleSecret\",\n    \"secretRules\" : [ {\n      \"ruleType\" : \"SECRET_EXPIRY_RULE\",\n      \"secretVersionExpiryInterval\" : \"P30D\",\n      \"timeOfAbsoluteExpiry\" : \"2023-03-18T22:00:00.000Z\",\n      \"isSecretContentRetrievalBlockedOnExpiry\" : false\n    } ],\n    \"timeCreated\" : \"2020-03-18T16:51:38.851Z\",\n    \"timeOfCurrentVersionExpiry\" : null,\n    \"timeOfDeletion\" : null,\n    \"vaultId\" : \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\",\n    \"isAutoGenerationEnabled\": true,\n    \"secretGenerationContext\": {\n      \"generationType\": \"PASSPHRASE\",\n      \"generationTemplate\": \"SECRETS_DEFAULT_PASSWORD\"\n    }\n  }\n]\n"
    ChangeSecretCompartmentDetails:
      description: Specifies the updated compartment OCID for the secret.
      properties:
        compartmentId:
          description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment

            into which the resource should be moved.

            '
          maxLength: 255
          minLength: 1
          type: string
      required:
      - compartmentId
      type: object
      x-example: "{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleayur5bs7qclkqyk7cvbgu44hdxvkjugqrqicjfcem7qri4example\"\n}\n"
    Error:
      description: An error.
      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
    SecretRule:
      description: A rule that you can apply to a secret to enforce certain conditions on the secret's usage and management.
      discriminator:
        propertyName: ruleType
      properties:
        ruleType:
          description: The type of rule, which either controls when the secret contents expire or whether they can be reused.
          enum:
          - SECRET_EXPIRY_RULE
          - SECRET_REUSE_RULE
          type: string
      required:
      - ruleType
      type: object
      x-example: "{\n  \"ruleType\": \"SECRET_EXPIRY_RULE\"\n}\n"
    SecretVersion:
      description: The details of the secret version, excluding the contents of the secret.
      properties:
        contentType:
          description: The content type of the secret version's secret contents.
          enum:
          - BASE64
          type: string
        isContentAutoGenerated:
          description: 'Boolean flag indicating whether secret content for this secret version was auto-generated or not.

            '
          type: boolean
        name:
          description: 'The name of the secret version. A name is unique across versions of a secret.

            '
          type: string
        secretId:
          description: The OCID of the secret.
          type: string
        stages:
          description: 'A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version

            marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated

            into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is

            always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked

            `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous

            one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion.

            '
          items:
            enum:
            - CURRENT
            - PENDING
            - LATEST
            - PREVIOUS
            - DEPRECATED
            type: string
          type: array
        timeCreated:
          description: 'A optional property indicating when the secret version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
        timeOfCurrentVersionExpiry:
          description: 'An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

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

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

            '
          format: date-time
          type: string
        versionNumber:
          description: The version number of the secret.
          format: int64
          type: integer
      type: object
      x-example: "[\n  {\n    \"contentType\": null,\n    \"name\": null,\n    \"secretId\": \"ocid1.vaultsecret.region1.sea.exampleanpy7c7qa6vugpr2lcvblz7bwbzahf25fdueaivyoy5jzlexample\",\n    \"stages\": [\"CURRENT\", \"LATEST\"],\n    \"timeCreated\": \"2020-03-19T04:56:53.048Z\",\n    \"timeOfDeletion\": null,\n    \"timeOfExpiry\": null,\n    \"versionNumber\": 1\n    ,\"isContentAutoGenerated\": false\n  }\n]\n"
    SecretGenerationContext:
      description: Captures a configurable set of secret generation rules such as length, base characters, additional characters, and so on.
      discriminator:
        propertyName: generationType
      properties:
        generationType:
          description: Name of the predefined secret generation type.
          enum:
          - PASSPHRASE
          - SSH_KEY
          - BYTES
          type: string
        secretTemplate:
          description: "SecretTemplate captures structure in which customer wants to store secrets. This is optional and a default structure is available for each secret type. \nThe template can have any structure with static values that are not generated. Within the template, you can insert predefined placeholders to store secrets. \nThese placeholders are later replaced with the generated content and saved as a Base64 encoded content.\n"
          type: string
      required:
      - generationType
      type: object
      x-example: "{\n  \"generationType\": \"SSH_KEY\",\n  \"generationTemplate\": \"RSA_3072\"\n}\n"
    SecretContentDetails:
      description: The content of the secret and metadata to help identify it.
      discriminator:
        propertyName: contentType
      properties:
        contentType:
          description: The base64-encoded content of the secret.
          enum:
          - BASE64
          type: string
        name:
          description: Names should be unique within a secret. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.
          maxLength: 50
          type: string
        stage:
          default: CURRENT
          description: 'The rotation state of the secret content. The default is `CURRENT`, meaning that the secret is currently in use. A secret version

            that you mark as `PENDING` is staged and available for use, but you don''t yet want to rotate it into current, active use. For example,

            you might create or update a secret and mark its rotation state as `PENDING` if you haven''t yet updated the secret on the target system.

            When creating a secret, only the value `CURRENT` is applicable, although the value `LATEST` is also automatically applied. When updating

            a secret, you can specify a version''s rotation state as either `CURRENT` or `PENDING`.

            '
          enum:
          - CURRENT
          - PENDING
          type: string
      required:
      - contentType
      type: object
      x-example: "{\n  \"content\": \"<var>&lt;secret_text&gt;</var>\",\n  \"contentType\": \"BASE64\",\n  \"stage\": \"PENDING\"\n}\n"
    SecretVersionSummary:
      description: The secret version summary object, which doesn't include the contents of the secret.
      properties:
        contentType:
          description: The content type of the secret version's secret contents.
          enum:
          - BASE64
          type: string
        isContentAutoGenerated:
          description: 'Boolean flag indicating whether secret content for this secret version was auto-generated or not.

            '
          type: boolean
        name:
          description: 'The name of the secret version. A name is unique across versions of a secret.

            '
          type: string
        secretId:
          description: The OCID of the secret.
          type: string
        stages:
          description: 'A list of possible rotation states for the secret version. A secret version marked `CURRENT` is currently in use. A secret version

            marked `PENDING` is staged and available for use, but has not been applied on the target system and, therefore, has not been rotated

            into current, active use. The secret most recently uploaded to a vault is always marked `LATEST`. (The first version of a secret is

            always marked as both `CURRENT` and `LATEST`.) A secret version marked `PREVIOUS` is the secret version that was most recently marked

            `CURRENT`, before the last secret version rotation. A secret version marked `DEPRECATED` is neither current, pending, nor the previous

            one in use. Only secret versions marked `DEPRECATED` can be scheduled for deletion.

            '
          items:
            enum:
            - CURRENT
            - PENDING
            - LATEST
            - PREVIOUS
            - DEPRECATED
            type: string
          type: array
        systemTags:
          additionalProperties:
            additionalProperties:
              description: 'The value of the tag. Only the String type is supported.

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

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

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


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

            '
          type: object
        timeCreated:
          description: 'A optional property indicating when the secret version was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

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

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

            '
          format: date-time
          type: string
        timeOfExpiry:
          description: 'An optional property indicating when the secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
        versionNumber:
          description: The version number of the secret.
          format: int64
          type: integer
      required:
      - secretId
      - timeCreated
      - versionNumber
      type: object
      x-example: "[ {\n  \"contentType\" : null,\n  \"name\" : null,\n  \"secretId\" : \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadl27cvbdsakdg5bbk4uodmjilfhworxzxfhmfexample\",\n  \"stages\" : [\n    \"CURRENT\",\n    \"LATEST\" ],\n  \"timeCreated\" : \"2020-03-19T02:58:46.010Z\",\n  \"timeOfDeletion\" : null,\n  \"timeOfExpiry\" : null,\n  \"versionNumber\" : 2,\n  \"systemTags\": {}\n  ,\"isContentAutoGenerated\": true\n}, {\n  \"contentType\" : null,\n  \"name\" : null,\n  \"secretId\" : \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadl27cvbdsakdg5bbk4uodmjilfhworxzxfhmfexample\",\n  \"stages\" : [ \"PREVIOUS\" ],\n  \"timeCreated\" : \"2020-03-17T00:52:19.820Z\",\n  \"timeOfDeletion\" : null,\n  \"timeOfExpiry\" : null,\n  \"versionNumber\" : 1,\n  \"systemTags\": {}\n  ,\"isContentAutoGenerated\": false\n} ]\n"
    ScheduleSecretVersionDeletionDetails:
      description: Schedules the deletion of the specified secret version.
      properties:
        timeOfDeletion:
          description: 'An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
      type: object
      x-example: "{\n  \"timeOfDeletion\": \"2020-04-18T05:30:00.000Z\"\n}\n"
    UpdateSecretDetails:
      description: Details for updating a secret.
      properties:
        currentVersionNumber:
          description: 'Details to update the secret version of the specified secret. The secret contents,

            version number, and rules can''t be specified at the same time.

            Updating the secret contents automatically creates a new secret version.

            '
          format: int64
          type: integer
        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. Avoid entering confidential information.
          type: string
        enableAutoGeneration:
          description: 'The value of this flag determines whether or not secret content will be generated automatically.

            '
          type: boolean
        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
        metadata:
          additionalProperties:
            type: object
          description: 'Additional metadata that you can use to provide context about how to use the secret or during rotation or

            other administrative tasks. For example, for a secret that you use to connect to a database, the additional

            metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

            '
          type: object
        rotationConfig:
          $ref: '#/components/schemas/RotationConfig'
        secretContent:
          $ref: '#/components/schemas/SecretContentDetails'
        secretGenerationContext:
          $ref: '#/components/schemas/SecretGenerationContext'
        secretRules:
          description: A list of rules to control how the secret is used and managed.
          items:
            $ref: '#/components/schemas/SecretRule'
          type: array
      type: object
      x-example: "{\n  \"description\": \"test secret - v2\",\n  \"currentVersionNumber\": 4\n}\n"
    ScheduleSecretDeletionDetails:
      description: Details for scheduling the deletion of the specified secret.
      properties:
        timeOfDeletion:
          description: 'An optional property indicating when to delete the secret version, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

            '
          format: date-time
          type: string
      type: object
      x-example: "{\n  \"timeOfDeletion\": \"2020-04-18T05:30:00.000Z\"\n}\n"
    Secret:
      description: The details of the secret. Secret details do not contain the contents of the secret itself.
      properties:
        compartmentId:
          description: The OCID of the compartment where you want to create the secret.
          type: string
        currentVersionNumber:
          description: The version number of the secret version that's currently in use.
          format: int64
          type: integer
        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. Avoid entering confidential information.
          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.

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

            '
          format: date-time
          type: string
        lifecycleDetails:
          description: Additional information about the current lifecycle state of the secret.
          maxLength: 4000
          minLength: 1
          type: string
        lifecycleState:
          description: The current lifecycle state of the secret.
          enum:
          - CREATING
          - ACTIVE
          - UPDATING
          - DELETING
          - DELETED
          - SCHEDULING_DELETION
          - PENDING_DELETION
          - CANCELLING_DELETION
          - FAILED
          type: string
        metadata:
          additionalProperties:
            type: object
          description: 'Additional metadata that you can use to provide context about how to use the secret or during rotation or

            other administrative tasks. For example, for a secret that you use to connect to a database, the additional

            metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

            '
          type: object
        nextRotationTime:
          description: 'A property indicating when the secret is scheduled to be rotated, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
        rotationConfig:
          $ref: '#/components/schemas/RotationConfig'
        rotationStatus:
          description: Additional information about the status of the secret rotation
          enum:
          - IN_PROGRESS
          - SCHEDULED
          - NOT_ENABLED
          - CANCELLING
          type: string
        secretGenerationContext:
          $ref: '#/components/schemas/SecretGenerationContext'
        secretName:
          description: The user-friendly name of the secret. Avoid entering confidential information.
          maxLength: 255
          type: string
        secretRules:
          description: A list of rules that control how the secret is used and managed.
          items:
            $ref: '#/components/schemas/SecretRule'
          type: array
        timeCreated:
          description: 'A property indicating when the secret was created, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

            '
          format: date-time
          type: string
        timeOfCurrentVersionExpiry:
          description: 'An optional property indicating when the current secret version will expire, expressed in [RFC 3339](https://tools.ietf.org/html/rfc3339) timestamp format.

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

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

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

            '
          format: date-time
          type: string
        vaultId:
          description: The OCID of the vault where the secret exists.
          type: string
      required:
      - id
      - vaultId
      - secretName
      - compartmentId
      - lifecycleState
      - timeCreated
      type: object
      x-example: "{\n  \"compartmentId\" : \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample\",\n  \"currentVersionNumber\" : 1,\n  \"definedTags\" : { },\n  \"description\" : \"example secret description\",\n  \"freeformTags\" : { },\n  \"id\" : \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample\",\n  \"keyId\" : \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example\",\n  \"lifecycleDetails\" : null,\n  \"lifecycleState\" : \"ACTIVE\",\n  \"metadata\" : null,\n  \"secretName\" : \"exampleSecret\",\n  \"secretRules\" : [ {\n    \"ruleType\" : \"SECRET_EXPIRY_RULE\",\n    \"secretVersionExpiryInterval\" : \"P30D\",\n    \"timeOfAbsoluteExpiry\" : \"2021-03-18T22:00:00.000Z\",\n    \"isSecretContentRetrievalBlockedOnExpiry\" : false\n  } ],\n  \"timeCreated\" : \"2020-03-18T16:51:38.851Z\",\n  \"timeOfCurrentVersionExpiry\" : null,\n  \"timeOfDeletion\" : null,\n  \"vaultId\" : \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\"\n}\n,{\n  \"compartmentId\" : \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample\",\n  \"currentVersionNumber\" : 1,\n  \"definedTags\" : { },\n  \"description\" : \"example secret description\",\n  \"freeformTags\" : { },\n  \"id\" : \"ocid1.vaultsecret.oc1.iad.exampleaz5qacpqadubrc4wwugrqmw5dnyzvcxwzds6er5enn2oamexample\",\n  \"keyId\" : \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example\",\n  \"lifecycleDetails\" : null,\n  \"lifecycleState\" : \"ACTIVE\",\n  \"metadata\" : null,\n  \"secretName\" : \"exampleSecret\",\n  \"secretRules\" : [ {\n    \"ruleType\" : \"SECRET_EXPIRY_RULE\",\n    \"secretVersionExpiryInterval\" : \"P30D\",\n    \"timeOfAbsoluteExpiry\" : \"2023-03-18T22:00:00.000Z\",\n    \"isSecretContentRetrievalBlockedOnExpiry\" : false\n  } ],\n  \"timeCreated\" : \"2020-03-18T16:51:38.851Z\",\n  \"timeOfCurrentVersionExpiry\" : null,\n  \"timeOfDeletion\" : null,\n  \"vaultId\" : \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\",\n  \"isAutoGenerationEnabled\": true,\n  \"secretGenerationContext\": {\n    \"generationType\": \"PASSPHRASE\",\n    \"generationTemplate\": \"SECRETS_DEFAULT_PASSWORD\"\n  }\n}\n"
    CreateSecretDetails:
      description: The details of the secret that you want to create.
      properties:
        compartmentId:
          description: The OCID of the compartment where you want to create 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. Avoid entering confidential information.
          maxLength: 4000
          type: string
        enableAutoGeneration:
          description: 'The value of this flag determines whether or not secret content will be generated automatically. If not set, it defaults to false.

            '
          type: boolean
        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
        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
          minLength: 1
          type: string
        metadata:
          additionalProperties:
            type: object
          description: 'Additional metadata that you can use to provide context about how to use the secret during rotation or

            other administrative tasks. For example, for a secret that you use to connect to a database, the additional

            metadata might specify the connection endpoint and the connection string. Provide additional metadata as key-value pairs.

            '
          type: object
        rotationConfig:
          $ref: '#/components/schemas/RotationConfig'
        secretContent:
          $ref: '#/components/schemas/SecretContentDetails'
        secretGenerationContext:
          $ref: '#/components/schemas/SecretGenerationContext'
        secretName:
          description: 'A user-friendly name for the secret. Secret names should be unique within a vault. Avoid entering confidential information. Valid characters are uppercase or lowercase letters, numbers, hyphens, underscores, and periods.

            '
          maxLength: 255
          type: string
        secretRules:
          description: A list of rules to control how the secret is used and managed.
          items:
            $ref: '#/components/schemas/SecretRule'
          type: array
        vaultId:
          description: The OCID of the vault where you want to create the secret.
          maxLength: 255
          minLength: 1
          type: string
      required:
      - vaultId
      - secretName
      - compartmentId
      - keyId
      type: object
      x-example: "{\n  \"vaultId\": \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\",\n  \"secretRules\": [ {\n    \"ruleType\" : \"SECRET_EXPIRY_RULE\",\n    \"secretVersionExpiryInterval\" : \"P30D\",\n    \"timeOfAbsoluteExpiry\" : \"2021-03-18T22:00:00.000Z\",\n    \"isSecretContentRetrievalBlockedOnExpiry\" : false\n  } ],\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample\",\n  \"secretName\": \"testSecret\",\n  \"description\": \"my test secret\",\n  \"keyId\": \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example\",\n  \"secretContent\": {\n      \"content\": \"<var>&lt;base64_encoded_secret_contents&gt;</var>\",\n      \"contentType\": \"BASE64\"\n  }\n}\n, {\n  \"vaultId\": \"ocid1.vault.oc1.iad.exampleyaaeuk.examplesuxtdqxczlvygwk4ouq2mhzr223g4o2ojs4o4q4ghmt6rlexample\",\n  \"secretRules\": [ {\n    \"ruleType\" : \"SECRET_EXPIRY_RULE\",\n    \"secretVersionExpiryInterval\" : \"P30D\",\n    \"timeOfAbsoluteExpiry\" : \"2023-03-18T22:00:00.000Z\",\n    \"isSecretContentRetrievalBlockedOnExpiry\" : false\n  } ],\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleah7zkvaffv26pzyauoe2zbncvbqvhvsudmlpe557wakiofexample\",\n  \"secretName\": \"testSecret\",\n  \"description\": \"my test secret\",\n  \"keyId\": \"ocid1.key.oc1.iad.exampleyaaeuk.abuwcvbrswr2nbvrraqomsmhopc74rlqupwyv3byhikd4577rrky7example\",\n  \"enableAutoGeneration\": true,\n  \"secretGenerationContext\": {\n      \"generationType\": \"PASSPHRASE\",\n      \"generationTemplate\": \"SECRETS_DEFAULT_PASSWORD\"\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: 1024
        minLength: 1
    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
    SecretVersionSortByQueryParam:
      description: 'The field to sort by. Only one sort order may be provided. Time created is default ordered as descending. Display name is default ordered as ascending.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - VERSION_NUMBER
        default: VERSION_NUMBER
    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
    FilterByNameQueryParam:
      description: The secret name.
      in: query
      name: name
      required: false
      x-default-description: The default value is null.
      schema:
        type: string
        maxLength: 255
    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
        default: 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
    SecretSortByQueryParam:
      description: 'The field to sort by. You can specify only one sort order. The default order for

        `TIMECREATED` is descending. The default order for `NAME` is ascending.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        - NAME
        default: NAME
    SecretIdRequiredPathParam:
      description: The OCID of the secret.
      in: path
      name: secretId
      required: true
      schema:
        type: string
    VaultIdQueryParam:
      description: The OCID of the vault.
      in: query
      name: vaultId
      required: false
      schema:
        type: string
        maxLength: 255
        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
    SecretVersionNumberRequiredPathParam:
      description: The version number of the secret.
      in: path
      name: secretVersionNumber
      required: true
      schema:
        type: integer
        format: int64
  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'
x-headers:
  etag:
    description: For optimistic concurrency control. See `if-match`.
    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#List_Pagination).

      '
    type: string
  opc-request-id:
    description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

      '
    type: string
  opc-work-request-id:
    description: 'The OCID of the work request. Use GetWorkRequest with this OCID to track the status of the request.

      '
    type: string
x-oracle-package: com.oracle.bmc.swagger.vault