{ "swagger": "2.0", "info": { "title": "KeyVaultClient", "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", "version": "7.4" }, "x-ms-parameterized-host": { "hostTemplate": "{vaultBaseUrl}", "useSchemePrefix": false, "positionInOperation": "first", "parameters": [ { "name": "vaultBaseUrl", "description": "The vault name, for example https://myvault.vault.azure.net.", "required": true, "type": "string", "in": "path", "x-ms-skip-url-encoding": true } ] }, "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/securitydomain/download/pending": { "get": { "tags": [ "HSMSecurityDomain" ], "operationId": "HSMSecurityDomain_DownloadPending", "description": "Retrieves the Security Domain download operation status", "responses": { "200": { "description": "Security Domain download operation status", "schema": { "$ref": "#/definitions/SecurityDomainOperationStatus" } }, "default": { "description": "Key Vault error response describing why the operation failed.", "schema": { "$ref": "common.json#/definitions/KeyVaultError" } } }, "x-ms-examples": { "Find Security Domain download operation status": { "$ref": "./examples/securitydomainoperationstatus-example.json" } } } }, "/securitydomain/download": { "post": { "tags": [ "HSMSecurityDomain" ], "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "operationId": "HSMSecurityDomain_Download", "description": "Retrieves the Security Domain from the managed HSM. Calling this endpoint can be used to activate a provisioned managed HSM resource.", "parameters": [ { "in": "body", "name": "CertificateInfoObject", "required": true, "schema": { "$ref": "#/definitions/CertificateInfoObject" }, "description": "The Security Domain download operation requires customer to provide N certificates (minimum 3 and maximum 10) containing a public key in JWK format." }, { "$ref": "common.json#/parameters/ApiVersionParameter" } ], "responses": { "202": { "description": "The response contains the Security Domain that is being confirmed.", "schema": { "$ref": "#/definitions/SecurityDomainObject" }, "headers": { "Retry-After": { "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", "type": "integer" }, "Azure-AsyncOperation": { "description": "The URI to poll for completion status.", "type": "string" } } }, "default": { "description": "Key Vault error response describing why the operation failed.", "schema": { "$ref": "common.json#/definitions/KeyVaultError" } } }, "x-ms-examples": { "Retrieve Security Domain": { "$ref": "./examples/securitydomaindownloadpost-example.json" } } } }, "/securitydomain/upload": { "get": { "tags": [ "HSMSecurityDomain" ], "parameters": [ { "$ref": "common.json#/parameters/ApiVersionParameter" } ], "operationId": "HSMSecurityDomain_TransferKey", "description": "Retrieve Security Domain transfer key", "responses": { "200": { "description": "Security Domain transfer key response", "schema": { "$ref": "#/definitions/TransferKey" } }, "default": { "description": "Key Vault error response describing why the operation failed.", "schema": { "$ref": "common.json#/definitions/KeyVaultError" } } }, "x-ms-examples": { "Retrieve Security Domain transfer key": { "$ref": "./examples/securitydomaintransferkey-example.json" } } }, "post": { "tags": [ "HSMSecurityDomain" ], "operationId": "HSMSecurityDomain_Upload", "x-ms-long-running-operation": true, "x-ms-long-running-operation-options": { "final-state-via": "azure-async-operation" }, "description": "Restore the provided Security Domain.", "parameters": [ { "in": "body", "name": "security_domain", "description": "The Security Domain to be restored.", "required": true, "schema": { "$ref": "#/definitions/SecurityDomainObject" } } ], "responses": { "202": { "description": "Restore of the Security Domain started.", "headers": { "Retry-After": { "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", "type": "integer" }, "Azure-AsyncOperation": { "description": "The URI to poll for completion status.", "type": "string" } }, "schema": { "$ref": "#/definitions/SecurityDomainOperationStatus" } }, "204": { "description": "Final response" }, "default": { "description": "Key Vault error response describing why the operation failed.", "schema": { "$ref": "common.json#/definitions/KeyVaultError" } } }, "x-ms-examples": { "Security Domain upload operation": { "$ref": "./examples/securitydomainuploadoperation-example.json" } } } }, "/securitydomain/upload/pending": { "get": { "tags": [ "HSMSecurityDomain" ], "operationId": "HSMSecurityDomain_UploadPending", "description": "Get Security Domain upload operation status", "responses": { "200": { "description": "Security Domain upload operation status", "schema": { "$ref": "#/definitions/SecurityDomainOperationStatus" } }, "default": { "description": "Key Vault error response describing why the operation failed.", "schema": { "$ref": "common.json#/definitions/KeyVaultError" } } }, "x-ms-examples": { "Find Security Domain upload operation status": { "$ref": "./examples/securitydomainoperationstatus-example.json" } } } } }, "definitions": { "CertificateInfoObject": { "properties": { "certificates": { "type": "array", "items": { "$ref": "#/definitions/SecurityDomainJsonWebKey" }, "minItems": 3, "maxItems": 10, "uniqueItems": true, "description": "Certificates needed from customer" }, "required": { "description": "Customer to specify the number of certificates (minimum 2 and maximum 10) to restore Security Domain", "type": "integer", "default": 2, "minimum": 2, "maximum": 10 } }, "required": [ "certificates" ] }, "TransferKey": { "properties": { "key_format": { "type": "string", "default": "jwk", "description": "Specifies the format of the transfer key" }, "transfer_key": { "$ref": "#/definitions/SecurityDomainJsonWebKey", "description": "Specifies the transfer key in JWK format" } }, "required": [ "transfer_key" ] }, "SecurityDomainObject": { "properties": { "value": { "type": "string", "description": "The Security Domain." } }, "description": "The Security Domain.", "required": [ "value" ] }, "SecurityDomainOperationStatus": { "properties": { "status": { "description": "operation status", "enum": [ "Success", "InProgress", "Failed" ], "x-ms-enum": { "modelAsString": false, "name": "OperationStatus" }, "type": "string" }, "status_details": { "type": "string" } } }, "SecurityDomainJsonWebKey": { "properties": { "kid": { "type": "string", "description": "Key identifier." }, "kty": { "type": "string", "description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. For Security Domain this value must be RSA." }, "key_ops": { "type": "array", "items": { "type": "string", "description": "Supported key operations." } }, "n": { "type": "string", "description": "RSA modulus." }, "e": { "type": "string", "description": "RSA public exponent." }, "x5c": { "description": "X509 certificate chain parameter", "type": "array", "items": { "type": "string" } }, "use": { "description": "Public Key Use Parameter. This is optional and if present must be enc.", "type": "string" }, "x5t": { "description": "X509 certificate SHA1 thumbprint. This is optional.", "type": "string" }, "x5t#S256": { "description": "X509 certificate SHA256 thumbprint.", "type": "string" }, "alg": { "description": "Algorithm intended for use with the key.", "type": "string" } }, "required": [ "kty", "key_ops", "alg", "kid", "x5c", "x5t#S256", "n", "e" ] } } }