{
  "opencollection": "1.0.0",
  "info": {
    "name": "Vault Key Management Kms Hsm Cluster API",
    "version": "release"
  },
  "items": [
    {
      "info": {
        "name": "kmsHsmCluster",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Lists all HSM cluster resources contained within the specified compartment.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20180608/hsmClusters",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "compartmentId",
                "value": "",
                "type": "query",
                "description": "The OCID of the compartment."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return in a paginated \"List\" call.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
              }
            ]
          },
          "docs": "Lists all HSM cluster resources contained within the specified compartment.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n"
        },
        {
          "info": {
            "name": "Creates a new HSM cluster resource",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20180608/hsmClusters",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Creates a new HSM cluster resource.\n"
        },
        {
          "info": {
            "name": "Gets details about a HSM Cluster resource.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20180608/hsmClusters/:hsmClusterId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ]
          },
          "docs": "Retrieves configuration details for the specified HSM Cluster resource.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning read operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nread operations exceeds 10 requests per second for a given tenancy.\n"
        },
        {
          "info": {
            "name": "Updates the properties of a HSM Cluster resource.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "/20180608/hsmClusters/:hsmClusterId",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Modifies properties of an HSM cluster resource, including `displayName`, `freeformTags` and `definedTags`.\n\nAs a provisioning operation, this call is subject to a Key Management limit that applies to\nthe total number of requests across all provisioning write operations. Key Management might\nthrottle this call to reject an otherwise valid request when the total rate of provisioning\nwrite operations exceeds 10 requests per second for a given tenancy.\n"
        },
        {
          "info": {
            "name": "Cancels the scheduled deletion of a HSM Cluster resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20180608/hsmClusters/:hsmClusterId/actions/cancelDeletion",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ]
          },
          "docs": "Cancels deletion of specified HSM Cluster, restores it and associated HSM partitions to pre-deletion states."
        },
        {
          "info": {
            "name": "Moves a HSM Cluster resource  into a different compartment.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20180608/hsmClusters/:hsmClusterId/actions/changeCompartment",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Moves a HSM Cluster resource to a different compartment within the same tenancy.\n"
        },
        {
          "info": {
            "name": "Download certificate signing request for the HSM Cluster resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20180608/hsmClusters/:hsmClusterId/actions/downloadCertificateSigningRequest",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ]
          },
          "docs": "Retrieves the certificate signing request for the designated HSM Cluster resource.\n"
        },
        {
          "info": {
            "name": "Schedules the deletion of a HSM Cluster resource.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20180608/hsmClusters/:hsmClusterId/actions/scheduleDeletion",
            "headers": [
              {
                "name": "if-match",
                "value": ""
              },
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Schedules HSM cluster for deletion, update its lifecycle state to 'PENDING_DELETION' \nand deletes it after the retention period.\n"
        },
        {
          "info": {
            "name": "Upload partition certificate and partition owner certificate for the HSM cluster.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "/20180608/hsmClusters/:hsmClusterId/actions/uploadPartitionCertificates",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              },
              {
                "name": "if-match",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Uploads the partition owner certificates to the HSM Cluster resource.\n"
        },
        {
          "info": {
            "name": "Lists all HSM and details for a HSM Cluster resource.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20180608/hsmClusters/:hsmClusterId/hsmPartitions",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of items to return in a paginated \"List\" call.\n"
              },
              {
                "name": "page",
                "value": "",
                "type": "query",
                "description": "The value of the `opc-next-page` response header\nfrom the previous \"List\" call.\n"
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "The field to sort by. You can specify only one sort order. The default\norder for `TIMECREATED` is descending. The default order for `DISPLAYNAME`\nis ascending.\n"
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`).\n"
              },
              {
                "name": "lifecycleState",
                "value": "",
                "type": "query",
                "description": "A filter that returns only resources that match the specified lifecycle state. The state value is case-insensitive."
              }
            ]
          },
          "docs": "Lists all HSM partitions within the specified HSM Cluster resource.\n"
        },
        {
          "info": {
            "name": "Get HSM information for the specific hsmPartitionId.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20180608/hsmClusters/:hsmClusterId/hsmPartitions/:hsmPartitionId",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              },
              {
                "name": "hsmPartitionId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Partition. This is a unique identifier which each hsmPartition will have."
              }
            ]
          },
          "docs": "Retrieves HSM partition details for the specified HSM cluster.\n"
        },
        {
          "info": {
            "name": "Get Pre Crypto Officer User Credentials.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "/20180608/hsmClusters/:hsmClusterId/preCoUserCredentials",
            "headers": [
              {
                "name": "opc-request-id",
                "value": ""
              },
              {
                "name": "opc-retry-token",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "hsmClusterId",
                "value": "",
                "type": "path",
                "description": "The OCID of the HSM Cluster. This is a unique identifier assigned to each hsmCluster."
              }
            ]
          },
          "docs": "Retrieves Pre Crypto Officer user credentials for the specified HSM cluster.\n"
        }
      ]
    }
  ],
  "bundled": true
}