{ "opencollection": "1.0.0", "info": { "name": "Vault Key Management Kms Management API", "version": "release" }, "items": [ { "info": { "name": "kmsManagement", "type": "folder" }, "items": [ { "info": { "name": "Lists keys in the specified vault and compartment.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/keys", "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" }, { "name": "protectionMode", "value": "", "type": "query", "description": "A key's protection mode indicates how the key persists and where cryptographic operations that use the key are performed. A\nprotection mode of `HSM` means that the key persists on a hardware security module (HSM) and all cryptographic operations are\nperformed inside the HSM. A protection mode of `SOFTWARE` means that the key persists on the server, protected by the vault's\nRSA wrapping key which persists on the HSM. All cryptographic operations that use a key with a protection mode of\n`SOFTWARE` are performed on the server.\nA protection mode of `EXTERNAL` mean that the key persists on the customer's external key manager which is hosted externally outside of oracle.\nOracle only hold a reference to that key. All cryptographic operations that use a key with a protection mode of `EXTERNAL` are performed by external key manager.\n" }, { "name": "algorithm", "value": "", "type": "query", "description": "The algorithm used by a key's key versions to encrypt or decrypt data. Currently, support includes AES, RSA, and ECDSA algorithms.\n" }, { "name": "length", "value": "", "type": "query", "description": "The length of the key in bytes, expressed as an integer. Supported values include 16, 24, or 32.\n" }, { "name": "curveId", "value": "", "type": "query", "description": "The curve ID of the keys. (This pertains only to ECDSA keys.)\n" } ] }, "docs": "Lists the master encryption keys in the specified vault and compartment.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n" }, { "info": { "name": "Creates a new key.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total\nnumber of requests across all management write operations. Key Management might throttle this call\nto reject an otherwise valid request when the total rate of management write operations exceeds 10\nrequests per second for a given tenancy.\n" }, { "info": { "name": "Restores a key to a vault from a file.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/actions/restoreFromFile", "headers": [ { "name": "content-length", "value": "" }, { "name": "if-match", "value": "" }, { "name": "content-md5", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ] }, "docs": "Restores the specified key to the specified vault, based on information in the backup file provided.\nIf the vault doesn't exist, the operation returns a response with a 404 HTTP status error code. You\nneed to first restore the vault associated with the key.\n" }, { "info": { "name": "Restores a key to a vault from an object storage location.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/actions/restoreFromObjectStore", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Restores the specified key to the specified vault from an Oracle Cloud Infrastructure\nObject Storage location. If the vault doesn't exist, the operation returns a response with a\n404 HTTP status error code. You need to first restore the vault associated with the key.\n" }, { "info": { "name": "Imports the given wrapped AES key.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/import", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports AES and RSA keys to create a new key. The key material must be base64-encoded \nand wrapped by the vault's public RSA wrapping key before you can import it. \nKey Management supports both RSA and AES keys. The AES keys are symmetric keys \nof length 128 bits (16 bytes), 192 bits (24 bytes), or 256 bits (32 bytes), and the RSA keys are asymmetric keys of length 2048 bits (256 bytes), 3072 bits (384 bytes), and 4096 bits (512 bytes). \nFurthermore, the key length must match what you specify at" }, { "info": { "name": "Gets details about a key.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/keys/:keyId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ] }, "docs": "Gets information about the specified master encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second for\na given tenancy.\n" }, { "info": { "name": "Updates a key's properties.", "type": "http" }, "http": { "method": "PUT", "url": "/20180608/keys/:keyId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a master encryption key. Specifically, you can update the\n`displayName`, `freeformTags`, and `definedTags` properties. Furthermore,\nthe key must be in an `ENABLED` or `CREATING` state to be updated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management writ" }, { "info": { "name": "Backs up the key and associated key metadata.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/actions/backup", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Backs up an encrypted file that contains all key versions and metadata of the specified key so that you can restore\nthe key later. The file also contains the metadata of the vault that the key belonged to.\n" }, { "info": { "name": "Cancels the scheduled deletion of a key.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/actions/cancelDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ] }, "docs": "Cancels the scheduled deletion of the specified key. Canceling\na scheduled deletion restores the key's lifecycle state to what\nit was before its scheduled deletion.\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 give" }, { "info": { "name": "Moves a key into a different compartment.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/actions/changeCompartment", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves a key into a different compartment within the same tenancy. For information about\nmoving resources between compartments, see [Moving Resources to a Different Compartment](/iaas/Content/Identity/Tasks/managingcompartments.htm#moveRes).\n\nWhen provided, if-match is checked against the ETag values of the key.\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\nth" }, { "info": { "name": "Disables a key so it cannot be used for cryptographic operations.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/actions/disable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ] }, "docs": "Disables a master encryption key so it can no longer be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n" }, { "info": { "name": "Enables a key so it can be used for cryptographic operations.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/actions/enable", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ] }, "docs": "Enables a master encryption key so it can be used for encryption, decryption, or\ngenerating new data encryption keys.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 requests per second\nfor a given tenancy.\n" }, { "info": { "name": "Schedules the deletion of a key.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/actions/scheduleDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules the deletion of the specified key. This sets the lifecycle state of the key\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\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 " }, { "info": { "name": "Lists all key versions for a key.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/keys/:keyId/keyVersions", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." }, { "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 [KeyVersion](/api/#/en/key/latest/KeyVersion/) resources for the specified\nmaster encryption key.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n" }, { "info": { "name": "Creates a new key version resource and rotates the key to use it for encryption.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/keyVersions", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Generates a new [KeyVersion](/api/#/en/key/latest/KeyVersion/) resource that provides new cryptographic\nmaterial for a master encryption key. The key must be in an `ENABLED` state to be rotated.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management write operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management write operations exceeds 10 reque" }, { "info": { "name": "Imports the given wrapped key material and then rotate the key to begin using the new key version for the specified key.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/keyVersions/import", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Imports AES key material to create a new key version and then rotate the key to begin using the new\nkey version. The key material must be base64-encoded and wrapped by the vault's public RSA wrapping key\nbefore you can import it. Key Management supports AES symmetric keys that are exactly 16, 24, or 32 bytes.\nFurthermore, the key length must match the length of the specified key and what you specify as the length\nat the time of import. When importing an asymmetric key, only the private key must " }, { "info": { "name": "Gets details about a key version.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/keys/:keyId/keyVersions/:keyVersionId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." }, { "name": "keyVersionId", "value": "", "type": "path", "description": "The OCID of the key version." } ] }, "docs": "Gets information about the specified key version.\n\nAs a management operation, this call is subject to a Key Management limit that applies to the total number\nof requests across all management read operations. Key Management might throttle this call to reject an\notherwise valid request when the total rate of management read operations exceeds 10 requests per second\nfor a given tenancy.\n" }, { "info": { "name": "Cancels the scheduled deletion of a key version.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/keyVersions/:keyVersionId/actions/cancelDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." }, { "name": "keyVersionId", "value": "", "type": "path", "description": "The OCID of the key version." } ] }, "docs": "Cancels the scheduled deletion of the specified key version. Canceling\na scheduled deletion restores the key version to its lifecycle state from\nbefore its scheduled deletion.\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" }, { "info": { "name": "Schedules the deletion of a key version.", "type": "http" }, "http": { "method": "POST", "url": "/20180608/keys/:keyId/keyVersions/:keyVersionId/actions/scheduleDeletion", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "keyId", "value": "", "type": "path", "description": "The OCID of the key." }, { "name": "keyVersionId", "value": "", "type": "path", "description": "The OCID of the key version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Schedules the deletion of the specified key version. This sets the lifecycle state of the key version\nto `PENDING_DELETION` and then deletes it after the specified retention period ends.\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" }, { "info": { "name": "Gets the replication status of a replica operation", "type": "http" }, "http": { "method": "GET", "url": "/20180608/replicaOperations/:replicationId/status", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "replicationId", "value": "", "type": "path", "description": "replicationId associated with an operation on a resource\n" } ] }, "docs": "When a vault has a replica, each operation on the vault or its resources, such as\nkeys, is replicated and has an associated replicationId. Replication status provides\ndetails about whether the operation associated with the given replicationId has been\nsuccessfully applied across replicas.\n" }, { "info": { "name": "Gets details about the RSA wrapping key associated with the vault.", "type": "http" }, "http": { "method": "GET", "url": "/20180608/wrappingKeys", "headers": [ { "name": "opc-request-id", "value": "" } ] }, "docs": "Gets details about the public RSA wrapping key associated with the vault in the endpoint. Each vault has an RSA key-pair that wraps and\nunwraps AES key material for import into Key Management.\n" } ] } ], "bundled": true }