Microsoft Azure

Azure Key Vault: Keys (7.4)

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Identity & security#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

The key vault client performs cryptographic key operations and vault operations against the Key Vault service.

Endpoints 24

Keys

  • POSTCreates a new key, stores it, then returns key parameters and attributes to the client./keys/:key-name/createThe create key operation can be used to create any key type in Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of the…
  • POSTCreates a new key version, stores it, then returns key parameters, attributes and policy to the client./keys/:key-name/rotateThe operation will rotate the key based on the key policy. It requires the keys/rotate permission.
  • PUTImports an externally created key, stores it, and returns key parameters and attributes to the client./keys/:key-nameThe import key operation may be used to import any key type into an Azure Key Vault. If the named key already exists, Azure Key Vault creates a new version of…
  • DELETEDeletes a key of any type from storage in Azure Key Vault./keys/:key-nameThe delete key operation cannot be used to remove individual versions of a key. This operation removes the cryptographic material associated with the key,…
  • GETGets the public part of a stored key./keys/:key-name/:key-versionThe get key operation is applicable to all key types. If the requested key is symmetric, then no key material is released in the response. This operation…
  • PATCHThe update key operation changes specified attributes of a stored key and can be applied to any key type and key version stored in Azure Key Vault./keys/:key-name/:key-versionIn order to perform this operation, the key must already exist in the Key Vault. Note: The cryptographic material of a key itself cannot be changed. This…
  • GETRetrieves a list of individual key versions with the same key name./keys/:key-name/versions?maxresults=1The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.
  • GETList keys in the specified vault./keys?maxresults=1Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a stored key. The LIST operation is applicable to all…
  • POSTRequests that a backup of the specified key be downloaded to the client./keys/:key-name/backupThe Key Backup operation exports a key from Azure Key Vault in a protected form. Note that this operation does NOT return key material in a form that can be…
  • POSTRestores a backed up key to a vault./keys/restoreImports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation…
  • POSTEncrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault./keys/:key-name/:key-version/encryptThe ENCRYPT operation encrypts an arbitrary sequence of bytes using an encryption key that is stored in Azure Key Vault. Note that the ENCRYPT operation only…
  • POSTDecrypts a single block of encrypted data./keys/:key-name/:key-version/decryptThe DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the…
  • POSTCreates a signature from a digest using the specified key./keys/:key-name/:key-version/signThe SIGN operation is applicable to asymmetric and symmetric keys stored in Azure Key Vault since this operation uses the private portion of the key. This…
  • POSTVerifies a signature using a specified key./keys/:key-name/:key-version/verifyThe VERIFY operation is applicable to symmetric keys stored in Azure Key Vault. VERIFY is not strictly necessary for asymmetric keys stored in Azure Key Vault…
  • POSTWraps a symmetric key using a specified key./keys/:key-name/:key-version/wrapkeyThe WRAP operation supports encryption of a symmetric key using a key encryption key that has previously been stored in an Azure Key Vault. The WRAP operation…
  • POSTUnwraps a symmetric key using the specified key that was initially used for wrapping that key./keys/:key-name/:key-version/unwrapkeyThe UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The…
  • POSTReleases a key./keys/:key-name/:key-version/releaseThe release key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/release permission.
  • GETLists the policy for a key./keys/:key-name/rotationpolicyThe GetKeyRotationPolicy operation returns the specified key policy resources in the specified key vault. This operation requires the keys/get permission.
  • PUTUpdates the rotation policy for a key./keys/:key-name/rotationpolicySet specified members in the key policy. Leave others as undefined. This operation requires the keys/update permission.

DeletedKeys

  • GETLists the deleted keys in the specified vault./deletedkeys?maxresults=1Retrieves a list of the keys in the Key Vault as JSON Web Key structures that contain the public part of a deleted key. This operation includes…
  • GETGets the public part of a deleted key./deletedkeys/:key-nameThe Get Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if…
  • DELETEPermanently deletes the specified key./deletedkeys/:key-nameThe Purge Deleted Key operation is applicable for soft-delete enabled vaults. While the operation can be invoked on any vault, it will return an error if…
  • POSTRecovers the deleted key to its latest version./deletedkeys/:key-name/recoverThe Recover Deleted Key operation is applicable for deleted keys in soft-delete enabled vaults. It recovers the deleted key back to its latest version under…

RNG

  • POSTGet the requested number of bytes containing random values./rngGet the requested number of bytes containing random values from a managed HSM.

API details

Authentication
None declared in the description
Operations
24 operations on 20 pathsPOST 13GET 6PUT 2DELETE 2PATCH 1
Main resources
Keys 19DeletedKeys 4RNG 1
Response formats
application/json
Description format
Swagger 2.0, API version 7.4

How to test the Azure Key Vault: Keys (7.4) in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Key Vault: Keys (7.4) collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Creates a new key, stores it, then returns key parameters and attributes to the client.” (POST /keys/:key-name/create), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Key Vault: Keys (7.4)?

The key vault client performs cryptographic key operations and vault operations against the Key Vault service. It is listed under Identity & security and has 24 endpoints.

Who publishes the Azure Key Vault: Keys (7.4)?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure Key Vault: Keys (7.4)?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure Key Vault: Keys (7.4) have?

24 operations on 20 paths (13 POST, 6 GET, 2 PUT, 2 DELETE, 1 PATCH). The largest groups are Keys, DeletedKeys, RNG.

Is forking the Azure Key Vault: Keys (7.4) free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.