Microsoft Azure

KeyVaultClient

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

Developer tools#openapi#cloud

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 78

Certificates

  • GETList certificates in a specified key vault/certificates?maxresults=1&includePending=true&api-version=stringThe GetCertificates operation returns the set of certificates resources in the specified key vault. This operation requires the certificates/list permission.
  • GETLists the certificate contacts for a specified key vault./certificates/contacts?api-version=stringThe GetCertificateContacts operation returns the set of certificate contact resources in the specified key vault. This operation requires the…
  • PUTSets the certificate contacts for the specified key vault./certificates/contacts?api-version=stringSets the certificate contacts for the specified key vault. This operation requires the certificates/managecontacts permission.
  • DELETEDeletes the certificate contacts for a specified key vault./certificates/contacts?api-version=stringDeletes the certificate contacts for a specified key vault certificate. This operation requires the certificates/managecontacts permission.
  • GETList certificate issuers for a specified key vault./certificates/issuers?maxresults=1&api-version=stringThe GetCertificateIssuers operation returns the set of certificate issuer resources in the specified key vault. This operation requires the…
  • GETLists the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe GetCertificateIssuer operation returns the specified certificate issuer resources in the specified key vault. This operation requires the…
  • PUTSets the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe SetCertificateIssuer operation adds or updates the specified certificate issuer. This operation requires the certificates/setissuers permission.
  • DELETEDeletes the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe DeleteCertificateIssuer operation permanently removes the specified certificate issuer from the vault. This operation requires the…
  • PATCHUpdates the specified certificate issuer./certificates/issuers/:issuer-name?api-version=stringThe UpdateCertificateIssuer operation performs an update on the specified certificate issuer entity. This operation requires the certificates/setissuers…
  • POSTRestores a backed up certificate to a vault./certificates/restore?api-version=stringRestores a backed up certificate, and all its versions, to a vault. This operation requires the certificates/restore permission.
  • DELETEDeletes a certificate from a specified key vault./certificates/:certificate-name?api-version=stringDeletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a…
  • POSTBacks up the specified certificate./certificates/:certificate-name/backup?api-version=stringRequests that a backup of the specified certificate be downloaded to the client. All versions of the certificate will be downloaded. This operation requires…
  • POSTCreates a new certificate./certificates/:certificate-name/create?api-version=stringIf this is the first version, the certificate resource is created. This operation requires the certificates/create permission.
  • POSTImports a certificate into a specified key vault./certificates/:certificate-name/import?api-version=stringImports an existing valid certificate, containing a private key, into Azure Key Vault. The certificate to be imported can be in either PFX or PEM format. If…
  • GETGets the creation operation of a certificate./certificates/:certificate-name/pending?api-version=stringGets the creation operation associated with a specified certificate. This operation requires the certificates/get permission.
  • DELETEDeletes the creation operation for a specific certificate./certificates/:certificate-name/pending?api-version=stringDeletes the creation operation for a specified certificate that is in the process of being created. The certificate is no longer created. This operation…
  • PATCHUpdates a certificate operation./certificates/:certificate-name/pending?api-version=stringUpdates a certificate creation operation that is already in progress. This operation requires the certificates/update permission.
  • POSTMerges a certificate or a certificate chain with a key pair existing on the server./certificates/:certificate-name/pending/merge?api-version=stringThe MergeCertificate operation performs the merging of a certificate or certificate chain with a key pair currently available in the service. This operation…
  • GETLists the policy for a certificate./certificates/:certificate-name/policy?api-version=stringThe GetCertificatePolicy operation returns the specified certificate policy resources in the specified key vault. This operation requires the certificates/get…
  • PATCHUpdates the policy for a certificate./certificates/:certificate-name/policy?api-version=stringSet specified members in the certificate policy. Leave others as null. This operation requires the certificates/update permission.
  • GETList the versions of a certificate./certificates/:certificate-name/versions?maxresults=1&api-version=stringThe GetCertificateVersions operation returns the versions of a certificate in the specified key vault. This operation requires the certificates/list permission.
  • GETGets information about a certificate./certificates/:certificate-name/:certificate-version?api-version=stringGets information about a specific certificate. This operation requires the certificates/get permission.
  • PATCHUpdates the specified attributes associated with the given certificate./certificates/:certificate-name/:certificate-version?api-version=stringThe UpdateCertificate operation applies the specified update on the given certificate; the only elements updated are the certificate's attributes. This…

DeletedCertificates

  • GETLists the deleted certificates in the specified vault currently available for recovery./deletedcertificates?maxresults=1&includePending=true&api-version=stringThe GetDeletedCertificates operation retrieves the certificates in the current vault which are in a deleted state and ready for recovery or purging. This…
  • GETRetrieves information about the specified deleted certificate./deletedcertificates/:certificate-name?api-version=stringThe GetDeletedCertificate operation retrieves the deleted certificate information plus its attributes, such as retention interval, scheduled permanent…
  • DELETEPermanently deletes the specified deleted certificate./deletedcertificates/:certificate-name?api-version=stringThe PurgeDeletedCertificate operation performs an irreversible deletion of the specified certificate, without possibility for recovery. The operation is not…
  • POSTRecovers the deleted certificate back to its current version under /certificates./deletedcertificates/:certificate-name/recover?api-version=stringThe RecoverDeletedCertificate operation performs the reversal of the Delete operation. The operation is applicable in vaults enabled for soft-delete, and must…

DeletedKeys

  • GETLists the deleted keys in the specified vault./deletedkeys?maxresults=1&api-version=stringRetrieves 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…

DeletedSecrets

  • GETLists deleted secrets for the specified vault./deletedsecrets?maxresults=1&api-version=stringThe Get Deleted Secrets operation returns the secrets that have been deleted for a vault enabled for soft-delete. This operation requires the secrets/list…
  • GETGets the specified deleted secret./deletedsecrets/:secret-name?api-version=stringThe Get Deleted Secret operation returns the specified deleted secret along with its attributes. This operation requires the secrets/get permission.
  • DELETEPermanently deletes the specified secret./deletedsecrets/:secret-name?api-version=stringThe purge deleted secret operation removes the secret permanently, without the possibility of recovery. This operation can only be enabled on a soft-delete…
  • POSTRecovers the deleted secret to the latest version./deletedsecrets/:secret-name/recover?api-version=stringRecovers the deleted secret in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the…

DeletedStorage

  • GETLists deleted storage accounts for the specified vault./deletedstorage?maxresults=1&api-version=stringThe Get Deleted Storage Accounts operation returns the storage accounts that have been deleted for a vault enabled for soft-delete. This operation requires…
  • GETGets the specified deleted storage account./deletedstorage/:storage-account-name?api-version=stringThe Get Deleted Storage Account operation returns the specified deleted storage account along with its attributes. This operation requires the storage/get…
  • DELETEPermanently deletes the specified storage account./deletedstorage/:storage-account-name?api-version=stringThe purge deleted storage account operation removes the secret permanently, without the possibility of recovery. This operation can only be performed on a…
  • POSTRecovers the deleted storage account./deletedstorage/:storage-account-name/recover?api-version=stringRecovers the deleted storage account in the specified vault. This operation can only be performed on a soft-delete enabled vault. This operation requires the…
  • GETLists deleted SAS definitions for the specified vault and storage account./deletedstorage/:storage-account-name/sas?maxresults=1&api-version=stringThe Get Deleted Sas Definitions operation returns the SAS definitions that have been deleted for a vault enabled for soft-delete. This operation requires the…
  • GETGets the specified deleted sas definition./deletedstorage/:storage-account-name/sas/:sas-definition-name?api-version=stringThe Get Deleted SAS Definition operation returns the specified deleted SAS definition along with its attributes. This operation requires the storage/getsas…
  • POSTRecovers the deleted SAS definition./deletedstorage/:storage-account-name/sas/:sas-definition-name/recover?api-version=stringRecovers the deleted SAS definition for the specified storage account. This operation can only be performed on a soft-delete enabled vault. This operation…

Keys

  • GETList keys in the specified vault./keys?maxresults=1&api-version=stringRetrieves 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…
  • 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…
  • 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,…
  • 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…
  • GETRetrieves a list of individual key versions with the same key name./keys/:key-name/versions?maxresults=1&api-version=stringThe full key identifier, attributes, and tags are provided in the response. This operation requires the keys/list permission.
  • 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…
  • 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…
  • 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…

Secrets

  • GETList secrets in a specified key vault./secrets?maxresults=1&api-version=stringThe Get Secrets operation is applicable to the entire vault. However, only the base secret identifier and its attributes are provided in the response.…
  • POSTRestores a backed up secret to a vault./secrets/restore?api-version=stringRestores a backed up secret, and all its versions, to a vault. This operation requires the secrets/restore permission.
  • PUTSets a secret in a specified key vault./secrets/:secret-name?api-version=stringThe SET 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…
  • DELETEDeletes a secret from a specified key vault./secrets/:secret-name?api-version=stringThe DELETE operation applies to any secret stored in Azure Key Vault. DELETE cannot be applied to an individual version of a secret. This operation requires…
  • POSTBacks up the specified secret./secrets/:secret-name/backup?api-version=stringRequests that a backup of the specified secret be downloaded to the client. All versions of the secret will be downloaded. This operation requires the…
  • GETList all versions of the specified secret./secrets/:secret-name/versions?maxresults=1&api-version=stringThe full secret identifier and attributes are provided in the response. No values are returned for the secrets. This operations requires the secrets/list…
  • GETGet a specified secret from a given key vault./secrets/:secret-name/:secret-version?api-version=stringThe GET operation is applicable to any secret stored in Azure Key Vault. This operation requires the secrets/get permission.
  • PATCHUpdates the attributes associated with a specified secret in a given key vault./secrets/:secret-name/:secret-version?api-version=stringThe UPDATE operation changes specified attributes of an existing stored secret. Attributes that are not specified in the request are left unchanged. The value…

Storage

  • GETGetStorageAccounts/storage?maxresults=1&api-version=stringList storage accounts managed by the specified key vault. This operation requires the storage/list permission.
  • POSTRestores a backed up storage account to a vault./storage/restore?api-version=stringRestores a backed up storage account to a vault. This operation requires the storage/restore permission.
  • GETGetStorageAccount/storage/:storage-account-name?api-version=stringGets information about a specified storage account. This operation requires the storage/get permission.
  • PUTSetStorageAccount/storage/:storage-account-name?api-version=stringCreates or updates a new storage account. This operation requires the storage/set permission.
  • DELETEDeleteStorageAccount/storage/:storage-account-name?api-version=stringDeletes a storage account. This operation requires the storage/delete permission.
  • PATCHUpdateStorageAccount/storage/:storage-account-name?api-version=stringUpdates the specified attributes associated with the given storage account. This operation requires the storage/set/update permission.
  • POSTBacks up the specified storage account./storage/:storage-account-name/backup?api-version=stringRequests that a backup of the specified storage account be downloaded to the client. This operation requires the storage/backup permission.
  • POSTRegenerateStorageAccountKey/storage/:storage-account-name/regeneratekey?api-version=stringRegenerates the specified key value for the given storage account. This operation requires the storage/regeneratekey permission.
  • GETGetSasDefinitions/storage/:storage-account-name/sas?maxresults=1&api-version=stringList storage SAS definitions for the given storage account. This operation requires the storage/listsas permission.
  • GETGetSasDefinition/storage/:storage-account-name/sas/:sas-definition-name?api-version=stringGets information about a SAS definition for the specified storage account. This operation requires the storage/getsas permission.
  • PUTSetSasDefinition/storage/:storage-account-name/sas/:sas-definition-name?api-version=stringCreates or updates a new SAS definition for the specified storage account. This operation requires the storage/setsas permission.
  • DELETEDeleteSasDefinition/storage/:storage-account-name/sas/:sas-definition-name?api-version=stringDeletes a SAS definition from a specified storage account. This operation requires the storage/deletesas permission.
  • PATCHUpdateSasDefinition/storage/:storage-account-name/sas/:sas-definition-name?api-version=stringUpdates the specified attributes associated with the given SAS definition. This operation requires the storage/setsas permission.

API details

Base URL
https://azure.local
Authentication
None declared in the description
Operations
78 operations on 55 pathsGET 28POST 24DELETE 12PATCH 8PUT 6
Main resources
Certificates 23Keys 15Storage 13Secrets 8DeletedStorage 7DeletedCertificates 4DeletedKeys 4DeletedSecrets 4
Response formats
application/json
Description format
Swagger 2.0, API version 7.0-preview
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the KeyVaultClient 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 KeyVaultClient 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 “List certificates in a specified key vault” (GET /certificates?maxresults=1&includePending=true&api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the KeyVaultClient?

The key vault client performs cryptographic key operations and vault operations against the Key Vault service. It is listed under Developer tools and has 78 endpoints.

Who publishes the KeyVaultClient?

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.

What is the base URL of the KeyVaultClient?

Requests go to https://azure.local. Endpoint paths are added to this base URL.

How do I authenticate with the KeyVaultClient?

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 KeyVaultClient have?

78 operations on 55 paths (28 GET, 24 POST, 12 DELETE, 8 PATCH, 6 PUT). The largest groups are Certificates, Keys, Storage, Secrets.

Is forking the KeyVaultClient 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.