Oracle Kms Hsm Cluster API

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

    '
  license:
    name: Oracle Corporation
  title: Vault Key Management Kms Hsm Cluster API
  version: release
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/6650b193f50d51919ae1a5f31b525097c777bb9e61575a82b12bf5a5fa5c1dea.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Vault Key Management API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/6650b193f50d51919ae1a5f31b525097c777bb9e61575a82b12bf5a5fa5c1dea.yaml
    what: the harvested document for Vault Key Management API
servers:
- url: /
tags:
- name: kmsHsmCluster
paths:
  /20180608/hsmClusters:
    get:
      description: 'Lists all HSM cluster resources contained within the specified compartment.


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

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

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

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

        '
      operationId: ListHsmClusters
      parameters:
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        '200':
          description: A list of HsmCluster resources.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

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

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

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HsmClusterCollection'
        '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 HSM cluster resources contained within the specified compartment.
      tags:
      - kmsHsmCluster
      x-example: 'GET /20180608/hsmClusters?compartmentId=<var>&lt;compartmentId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/HsmCluster'
    post:
      description: 'Creates a new HSM cluster resource.

        '
      operationId: CreateHsmCluster
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '200':
          description: HsmCluster resource 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/HsmCluster'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Creates a new HSM cluster resource
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5ltpneskcfy7lr4a6wfauxuwrwed5bsdea\",\n  \"displayName\": \"Hsm Cluster 1\"\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateHsmClusterDetails'
        description: Details for the new HsmCluster resource
        required: true
  /20180608/hsmClusters/{hsmClusterId}:
    get:
      description: 'Retrieves configuration details for the specified HSM Cluster resource.


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

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

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

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

        '
      operationId: GetHsmCluster
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The specified HSM Cluster resource.
          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/HsmCluster'
        '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 HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: 'GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>

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

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

        '
      x-related-resource: '#/definitions/HsmCluster'
    put:
      description: 'Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`.


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

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

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

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

        '
      operationId: UpdateHsmCluster
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The HSM Cluster resource is updated according to the request.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HsmCluster'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Updates the properties of a HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "PUT /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"displayName\": \"Hsm 1\"\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateHsmClusterDetails'
        description: Details of the HsmCluster Resource
        required: true
  /20180608/hsmClusters/{hsmClusterId}/actions/cancelDeletion:
    post:
      description: Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states.
      operationId: CancelHsmClusterDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The HSM Cluster resource's scheduled deletion is cancelled successfully
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HsmCluster'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        '404':
          $ref: '#/components/responses/404'
        '409':
          $ref: '#/components/responses/409'
        '412':
          $ref: '#/components/responses/412'
        '429':
          $ref: '#/components/responses/429'
        '500':
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: Cancels the scheduled deletion of a HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/cancelDeletion\nHost: kms.us-ashburn-1.oraclecloud.com \n<var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
  /20180608/hsmClusters/{hsmClusterId}/actions/changeCompartment:
    post:
      description: 'Moves a HSM Cluster resource to a different compartment within the same tenancy.

        '
      operationId: ChangeHsmClusterCompartment
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        '204':
          description: The compartment information for the HSM Cluster resource 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 HSM Cluster resource  into a different compartment.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/changeCompartment\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"compartmentId\": \"ocid1.tenancy.oc1..exampleati4wjo6cvbxq4iusld5lsdneskcfy7lr4a6wfauxuwrwed5b3xea\",\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ChangeHsmClusterCompartmentDetails'
        description: Details of change HSM Cluster compartment.
        required: true
  /20180608/hsmClusters/{hsmClusterId}/actions/downloadCertificateSigningRequest:
    post:
      description: 'Retrieves the certificate signing request for the designated HSM Cluster resource.

        '
      operationId: DownloadCertificateSigningRequest
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The request is processed successfully. The CSR will be returned in the body of the response.
          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:
                maxLength: 5000
                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: Download certificate signing request for the HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/downloadCertificateSigningRequest\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
  /20180608/hsmClusters/{hsmClusterId}/actions/scheduleDeletion:
    post:
      description: "Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' \nand deletes it after the retention period.\n"
      operationId: ScheduleHsmClusterDeletion
      parameters:
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The HSM Cluster resource is scheduled for deletion.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HsmCluster'
        '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 HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/scheduleDeletion\nHost: kms.us-ashburn-1.oraclecloud.com\n<var>&lt;authorization and other headers&gt;</var>\n{\n  \"timeOfDeletion\": \"2023-04-03T21:10:29.600Z\"\n}\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleHsmClusterDeletionDetails'
        description: Details of ScheduleHsmClusterDeletionDetails
        required: true
  /20180608/hsmClusters/{hsmClusterId}/actions/uploadPartitionCertificates:
    post:
      description: 'Uploads the partition owner certificates to the HSM Cluster resource.

        '
      operationId: UploadPartitionCertificates
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: Partition certificates uploaded successfully.
          headers:
            etag:
              description: For optimistic concurrency control. See `if-match`.
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about

                a particular request, please provide the request ID.

                '
              schema:
                type: string
        '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: Upload partition certificate and partition owner certificate for the HSM cluster.
      tags:
      - kmsHsmCluster
      x-example: "POST /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/actions/uploadPartitionCertificates\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UploadPartitionCertificatesDetails'
        description: To upload partition certificates.
        required: true
  /20180608/hsmClusters/{hsmClusterId}/hsmPartitions:
    get:
      description: 'Lists all HSM partitions within the specified HSM Cluster resource.

        '
      operationId: ListHsmPartitions
      parameters:
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - 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/HsmPartition/lifecycleState'
        schema:
          type: string
      responses:
        '200':
          description: List of HSM summary is returned.
          headers:
            opc-next-page:
              description: 'For pagination of a list of items. When paging through a list, if this header appears in the response,

                then there are additional items still to get. Include this value as the `page` parameter for the

                subsequent GET request. For information about pagination, see

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

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

                a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HsmPartitionCollection'
        '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: Lists all HSM and details for a HSM Cluster resource.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/hsmPartitions\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmPartition'
  /20180608/hsmClusters/{hsmClusterId}/hsmPartitions/{hsmPartitionId}:
    get:
      description: 'Retrieves HSM partition details for the specified HSM cluster.

        '
      operationId: GetHsmPartition
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      - $ref: '#/components/parameters/HsmPartitionIdPathParam'
      responses:
        '200':
          description: The request is processed successfully. HSM information is returned as response.
          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/HsmPartition'
        '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: Get HSM information for the specific hsmPartitionId.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmCluster/<var>&lt;hsmClusterId&gt;</var>/hsmPartitions/<var>&lt;hsmPartitionId&gt;</var>/hsmPartitionId\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmPartition'
  /20180608/hsmClusters/{hsmClusterId}/preCoUserCredentials:
    get:
      description: 'Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.

        '
      operationId: GetPreCoUserCredentials
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      - $ref: '#/components/parameters/HsmClusterIdPathParam'
      responses:
        '200':
          description: The request is processed successfully. The preCo username and password will be returned in the body of the response. Copy credentials for your records will not be shown again.
          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/PreCoUserCredentials'
        '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: Get Pre Crypto Officer User Credentials.
      tags:
      - kmsHsmCluster
      x-example: "GET /20180608/hsmClusters/<var>&lt;hsmClusterId&gt;</var>/preCoUserCredentials\n       Host: kms.us-ashburn-1.oraclecloud.com\n       <var>&lt;authorization and other headers&gt;</var>\n"
      x-related-resource: '#/definitions/HsmCluster'
components:
  parameters:
    PaginationTokenQueryParam:
      description: 'The value of the `opc-next-page` response header

        from the previous "List" call.

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

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

        is ascending.

        '
      in: query
      name: sortBy
      required: false
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
    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
    HsmPartitionIdPathParam:
      description: The OCID of the HSM Partition. This is a unique identifier which each hsmPartition will have.
      in: path
      name: hsmPartitionId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    PaginationLimitQueryParam:
      description: 'The maximum number of items to return in a paginated "List" call.

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

        '
      in: query
      name: sortOrder
      required: false
      schema:
        type: string
        enum:
        - ASC
        - DESC
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case

        of a timeout or server error without risk of executing that same action

        again. Retry tokens expire after 24 hours, but can be invalidated

        before then due to conflicting operations (e.g., if a resource has been

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

        creation request may be rejected).

        '
      in: header
      name: opc-retry-token
      required: false
      schema:
        type: string
        maxLength: 64
        minLength: 1
    HsmClusterIdPathParam:
      description: The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster.
      in: path
      name: hsmClusterId
      required: true
      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
  schemas:
    Error:
      description: The desciption of Error message.
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

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

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
    UploadPartitionCertificatesDetails:
      description: An object that encapsulates the necessary partition certificates.
      properties:
        partitionCertificate:
          description: Base64 encoded (StandardCharsets.UTF_8) Partition Certificate, which gets created when the CSR is signed.
          maxLength: 5000
          type: string
        partitionOwnerCertificate:
          description: Base64 encoded (StandardCharsets.UTF_8) Partition Owner Certificate, which is used to help sign the CSR.
          maxLength: 5000
          type: string
      required:
      - partitionCertificate
      - partitionO

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