{ "basePath": "/", "consumes": [], "definitions": {}, "host": "my-key-vault.vault.azure.net", "info": { "description": "A sample connector for the Azure Key Vault service. This connector is built for the Azure Key Vault REST API. You can see the details of the API here: https://docs.microsoft.com/rest/api/keyvault/.", "title": "Azure Key Vault [Sample]", "version": "1.0" }, "parameters": {}, "paths": { "/keys": { "get": { "description": "List keys in the specified vault. For details, see https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-keys/get-keys.", "operationId": "ListKey", "parameters": [ { "in": "query", "name": "maxresults", "required": false, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" } ], "responses": { "200": { "description": "default", "schema": { "properties": { "nextLink": { "description": "nextLink", "type": "string" }, "value": { "description": "value", "items": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "recoverylevel": { "description": "recoverylevel", "type": "string" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "kid": { "description": "kid", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "summary": "List keys" } }, "/keys/{key-name}": { "get": { "description": "Gets the public part of a stored key. If the requested key is symmetric, then no key material is released in the response. For more details, refer: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/get-key/get-key.", "operationId": "GetKey", "parameters": [ { "in": "path", "name": "key-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" } ], "responses": { "200": { "description": "default", "schema": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "recoverylevel": { "description": "recoverylevel", "type": "string" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "key": { "description": "key", "properties": { "e": { "description": "e", "type": "string" }, "key_ops": { "description": "key_ops", "items": { "type": "string" }, "type": "array" }, "kid": { "description": "kid", "type": "string" }, "kty": { "description": "kty", "type": "string" }, "n": { "description": "n", "type": "string" } }, "type": "object" }, "tags": { "description": "tags", "properties": { "purpose": { "description": "purpose", "type": "string" }, "test name ": { "description": "test name ", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Get key" } }, "/keys/{key-name}/create": { "post": { "description": "Creates a new key, stores it, then returns key parameters and attributes. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/create-key/create-key.", "operationId": "CreateKey", "parameters": [ { "in": "path", "name": "key-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" }, { "in": "body", "name": "body", "required": true, "schema": { "properties": { "key_ops": { "description": "key_ops", "items": { "description": "JSON web key operations", "enum": [ "encrypt", "decrypt", "sign", "verify", "wrapKey", "unwrapKey" ], "type": "string" }, "type": "array" }, "key_size": { "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA.", "format": "int32", "type": "integer" }, "kty": { "description": "The type of key to create. For valid values, see JsonWebKeyType.", "enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ], "type": "string" } }, "required": [ "kty" ], "type": "object" } } ], "responses": { "200": { "description": "default", "schema": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "recoverylevel": { "description": "recoverylevel", "type": "string" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "key": { "description": "key", "properties": { "e": { "description": "e", "type": "string" }, "key_ops": { "description": "key_ops", "items": { "type": "string" }, "type": "array" }, "kid": { "description": "kid", "type": "string" }, "kty": { "description": "kty", "type": "string" }, "n": { "description": "n", "type": "string" } }, "type": "object" }, "tags": { "description": "tags", "properties": { "purpose": { "description": "purpose", "type": "string" }, "test name ": { "description": "test name ", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "summary": "Create key" } }, "/keys/{key-name}/decrypt": { "post": { "description": "Decrypts a single block of encrypted data. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/decrypt/decrypt.", "operationId": "Decrypt", "parameters": [ { "in": "path", "name": "key-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" }, { "in": "body", "name": "body", "required": true, "schema": { "properties": { "alg": { "description": "The encryption algorithm", "enum": [ "RSA-OAEP", "RSA-OAEP-256", "RSA1_5" ], "type": "string" }, "value": { "description": "The data to be decrypted", "format": "byte", "type": "string" } }, "required": [ "value", "alg" ], "type": "object" } } ], "responses": { "200": { "description": "default", "schema": { "properties": { "kid": { "description": "Key identifier", "type": "string" }, "value": { "description": "The decrypted value", "format": "byte", "type": "string" } }, "type": "object" } } }, "summary": "Decrypt data" } }, "/keys/{key-name}/encrypt": { "post": { "description": "Encrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/keys/encrypt/encrypt.", "operationId": "Encrypt", "parameters": [ { "in": "path", "name": "key-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" }, { "in": "body", "name": "body", "required": true, "schema": { "properties": { "alg": { "description": "The encryption algorithm to be used", "enum": [ "RSA-OAEP", "RSA-OAEP-256", "RSA1_5" ], "type": "string" }, "value": { "description": "The data to be encrypted", "format": "byte", "type": "string" } }, "required": [ "alg", "value" ], "type": "object" } } ], "responses": { "200": { "description": "default", "schema": { "properties": { "kid": { "description": "Key identifier", "type": "string" }, "value": { "description": "Encrypted data", "format": "byte", "type": "string" } }, "type": "object" } } }, "summary": "Encrypt data" } }, "/secrets": { "get": { "description": "List secrets in a specified key vault. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secret/get-secret.", "operationId": "ListSecret", "parameters": [ { "description": "Maximum number of results to return in a page. If not specified, the service will return up to 25 results.", "in": "query", "name": "maxresults", "required": false, "type": "integer", "x-ms-summary": "Max results" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" } ], "responses": { "200": { "description": "default", "schema": { "properties": { "nextLink": { "description": "nextLink", "type": "string" }, "value": { "description": "value", "items": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "contentType": { "description": "contentType", "type": "string" }, "id": { "description": "id", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "summary": "List secrets" } }, "/secrets/{secret-name}": { "get": { "description": "Get a specified secret from a given key vault. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secret/get-secret.", "operationId": "GetSecret", "parameters": [ { "in": "path", "name": "secret-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" } ], "responses": { "200": { "description": "default", "schema": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "recoverylevel": { "description": "recoverylevel", "type": "string" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "id", "type": "string" }, "value": { "description": "value", "format": "byte", "type": "string" } }, "type": "object" } } }, "summary": "Get secret" }, "put": { "description": "Sets a secret in a specified key vault. This operation adds a secret to the Azure Key Vault. If the named secret already exists, Azure Key Vault creates a new version of that secret. This operation requires the secrets/set permission. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/set-secret/set-secret.", "operationId": "SetSecret", "parameters": [ { "in": "path", "name": "secret-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" }, { "in": "body", "name": "body", "required": true, "schema": { "properties": { "attributes": { "description": "attributes", "properties": { "enabled": { "description": "Determines whether the object is enabled.", "type": "boolean" } }, "type": "object" }, "value": { "description": "The value of the secret.", "type": "string" } }, "required": [ "value" ], "type": "object" } } ], "responses": { "200": { "description": "default", "schema": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "recoverylevel": { "description": "recoverylevel", "type": "string" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "id", "type": "string" }, "value": { "description": "value", "type": "string" } }, "type": "object" } } }, "summary": "Create or update secret value" } }, "/secrets/{secret-name}/versions": { "get": { "description": "List all versions of the specified secret. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secret-versions/get-secret-versions.", "operationId": "ListSecretVersions", "parameters": [ { "in": "path", "name": "secret-name", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" } ], "responses": { "200": { "description": "default", "schema": { "properties": { "nextLink": { "description": "nextLink", "type": "string" }, "value": { "description": "value", "items": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "id", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "summary": "List secret versions" } }, "/secrets/{secret-name}/{secret-version}": { "get": { "description": "Get the value of a specified secret version from a given key vault. For details, see: https://learn.microsoft.com/en-us/rest/api/keyvault/secrets/get-secret/get-secret.", "operationId": "GetSecretVersion", "parameters": [ { "in": "path", "name": "secret-name", "required": true, "type": "string" }, { "in": "path", "name": "secret-version", "required": true, "type": "string" }, { "default": "7.0", "in": "query", "name": "api-version", "required": true, "type": "string", "x-ms-visibility": "internal" } ], "responses": { "200": { "description": "default", "schema": { "properties": { "attributes": { "description": "attributes", "properties": { "created": { "description": "created", "format": "int32", "type": "integer" }, "enabled": { "description": "enabled", "type": "boolean" }, "recoverylevel": { "description": "recoverylevel", "type": "string" }, "updated": { "description": "updated", "format": "int32", "type": "integer" } }, "type": "object" }, "id": { "description": "id", "type": "string" }, "value": { "description": "value", "type": "string" } }, "type": "object" } } }, "summary": "Get secret version" } } }, "produces": [], "responses": {}, "schemes": [ "https" ], "security": [ { "oauth2_auth": [] } ], "securityDefinitions": { "oauth2_auth": { "authorizationUrl": "https://login.windows.net/common/oauth2/authorize", "flow": "accessCode", "scopes": {}, "tokenUrl": "https://login.windows.net/common/oauth2/authorize", "type": "oauth2" } }, "swagger": "2.0", "tags": [] }