Azure Key Vault: Keys
The key vault client performs cryptographic key operations and vault operations against the Key Vault service.
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 25
- GETLists the deleted keys in the specified vault.
/deletedkeys?api-version=string&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-name?api-version=stringThe 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-name?api-version=stringThe 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/recover?api-version=stringThe 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… - GETList keys in the specified vault.
/keys?api-version=string&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… - PUTImports an externally created key, stores it, and returns key parameters and attributes to the client.
/keys/:key-name?api-version=stringThe 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-name?api-version=stringThe 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-version?api-version=stringThe 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-version?api-version=stringIn 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… - GETGets the public part of a stored key along with its attestation blob.
/keys/:key-name/:key-version/attestation?api-version=stringThe get key attestation operation returns the key along with its attestation blob. This operation requires the keys/get permission. - POSTDecrypts a single block of encrypted data.
/keys/:key-name/:key-version/decrypt?api-version=stringThe DECRYPT operation decrypts a well-formed block of ciphertext using the target encryption key and specified algorithm. This operation is the reverse of the… - POSTEncrypts an arbitrary sequence of bytes using an encryption key that is stored in a key vault.
/keys/:key-name/:key-version/encrypt?api-version=stringThe 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… - POSTReleases a key.
/keys/:key-name/:key-version/release?api-version=stringThe release key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/release permission. - POSTCreates a signature from a digest using the specified key.
/keys/:key-name/:key-version/sign?api-version=stringThe 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… - POSTUnwraps a symmetric key using the specified key that was initially used for wrapping that key.
/keys/:key-name/:key-version/unwrapkey?api-version=stringThe UNWRAP operation supports decryption of a symmetric key using the target key encryption key. This operation is the reverse of the WRAP operation. The… - POSTVerifies a signature using a specified key.
/keys/:key-name/:key-version/verify?api-version=stringThe 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/wrapkey?api-version=stringThe 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… - POSTRequests that a backup of the specified key be downloaded to the client.
/keys/:key-name/backup?api-version=stringThe 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… - POSTCreates a new key, stores it, then returns key parameters and attributes to the client.
/keys/:key-name/create?api-version=stringThe 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/rotate?api-version=stringThe operation will rotate the key based on the key policy. It requires the keys/rotate permission. - GETLists the policy for a key.
/keys/:key-name/rotationpolicy?api-version=stringThe 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/rotationpolicy?api-version=stringSet specified members in the key policy. Leave others as undefined. This operation requires the keys/update permission. - GETRetrieves a list of individual key versions with the same key name.
/keys/:key-name/versions?api-version=string&maxresults=1The full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission. - POSTRestores a backed up key to a vault.
/keys/restore?api-version=stringImports a previously backed up key into Azure Key Vault, restoring the key, its key identifier, attributes and access control policies. The RESTORE operation… - POSTGet the requested number of bytes containing random values.
/rng?api-version=stringGet the requested number of bytes containing random values from a managed HSM.
API details
- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 25 operations on 21 pathsPOST 13GET 7PUT 2DELETE 2PATCH 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
7.6 - Links
- OpenAPI document
How to test the Azure Key Vault: Keys in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Key Vault: Keys collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Lists the deleted keys in the specified vault.” (GET /deletedkeys?api-version=string&maxresults=1), 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?
The key vault client performs cryptographic key operations and vault operations against the Key Vault service. It is listed under Identity & security and has 25 endpoints.
Who publishes the Azure Key Vault: Keys?
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?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Key Vault: Keys have?
25 operations on 21 paths (13 POST, 7 GET, 2 PUT, 2 DELETE, 1 PATCH).
Is forking the Azure Key Vault: Keys free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.