Get Key - Get Key

Reference

Service:: Key Vault

API Version:: 7.4

Gets the public part of a stored key.
The 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 requires the keys/get permission.

GET {vaultBaseUrl}/keys/{key-name}/{key-version}?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
key-name	path	True	string	The name of the key to get.
key-version	path	True	string	Adding the version parameter retrieves a specific version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned.
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	KeyBundle	A key bundle containing the key and its attributes.
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

Get key

Sample request

HTTP

GET https://myvault.vault.azure.net//keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71?api-version=7.4

Sample response

Status code:: 200

{
  "key": {
    "kid": "https://myvault.vault.azure.net/keys/CreateSoftKeyTest/78deebed173b48e48f55abf87ed4cf71",
    "kty": "RSA",
    "key_ops": [
      "encrypt",
      "decrypt",
      "sign",
      "verify",
      "wrapKey",
      "unwrapKey"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB"
  },
  "attributes": {
    "enabled": true,
    "created": 1493942451,
    "updated": 1493942451,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "tags": {
    "purpose": "unit test",
    "test name ": "CreateGetDeleteKeyTest"
  }
}

Definitions

Name	Description
DeletionRecoveryLevel	Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.
Error	The key vault server error.
JsonWebKey	As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18
JsonWebKeyCurveName	Elliptic curve name. For valid values, see JsonWebKeyCurveName.
JsonWebKeyType	JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
KeyAttributes	The attributes of a key managed by the key vault service.
KeyBundle	A KeyBundle consisting of a WebKey plus its attributes.
KeyReleasePolicy	The policy rules under which the key can be exported.
KeyVaultError	The key vault error exception.

DeletionRecoveryLevel

Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.

Name	Type	Description
CustomizedRecoverable	string	Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available.
CustomizedRecoverable+ProtectedSubscription	string	Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled.
CustomizedRecoverable+Purgeable	string	Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled.
Purgeable	string	Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)
Recoverable	string	Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered
Recoverable+ProtectedSubscription	string	Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered
Recoverable+Purgeable	string	Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

JsonWebKey

As of http://tools.ietf.org/html/draft-ietf-jose-json-web-key-18

Name	Type	Description
crv	JsonWebKeyCurveName	Elliptic curve name. For valid values, see JsonWebKeyCurveName.
d	string	RSA private exponent, or the D component of an EC private key.
dp	string	RSA private key parameter.
dq	string	RSA private key parameter.
e	string	RSA public exponent.
k	string	Symmetric key.
key_hsm	string	Protected Key, used with 'Bring Your Own Key'.
key_ops	string[]	Supported key operations.
kid	string	Key identifier.
kty	JsonWebKeyType	JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.
n	string	RSA modulus.
p	string	RSA secret prime.
q	string	RSA secret prime, with p < q.
qi	string	RSA private key parameter.
x	string	X component of an EC public key.
y	string	Y component of an EC public key.

JsonWebKeyCurveName

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

Name	Type	Description
P-256	string	The NIST P-256 elliptic curve, AKA SECG curve SECP256R1.
P-256K	string	The SECG SECP256K1 elliptic curve.
P-384	string	The NIST P-384 elliptic curve, AKA SECG curve SECP384R1.
P-521	string	The NIST P-521 elliptic curve, AKA SECG curve SECP521R1.

JsonWebKeyType

JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.

Name	Type	Description
EC	string	Elliptic Curve.
EC-HSM	string	Elliptic Curve with a private key which is stored in the HSM.
RSA	string	RSA (https://tools.ietf.org/html/rfc3447)
RSA-HSM	string	RSA with a private key which is stored in the HSM.
oct	string	Octet sequence (used to represent symmetric keys)
oct-HSM	string	Octet sequence (used to represent symmetric keys) which is stored the HSM.

KeyAttributes

The attributes of a key managed by the key vault service.

Name	Type	Description
created	integer	Creation time in UTC.
enabled	boolean	Determines whether the object is enabled.
exp	integer	Expiry date in UTC.
exportable	boolean	Indicates if the private key can be exported. Release policy must be provided when creating the first version of an exportable key.
nbf	integer	Not before date in UTC.
recoverableDays	integer	softDelete data retention days. Value should be >=7 and <=90 when softDelete enabled, otherwise 0.
recoveryLevel	DeletionRecoveryLevel	Reflects the deletion recovery level currently in effect for keys in the current vault. If it contains 'Purgeable' the key can be permanently deleted by a privileged user; otherwise, only the system can purge the key, at the end of the retention interval.
updated	integer	Last updated time in UTC.

KeyBundle

A KeyBundle consisting of a WebKey plus its attributes.

Name	Type	Description
attributes	KeyAttributes	The key management attributes.
key	JsonWebKey	The Json web key.
managed	boolean	True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true.
release_policy	KeyReleasePolicy	The policy rules under which the key can be exported.
tags	object	Application specific metadata in the form of key-value pairs.

KeyReleasePolicy

The policy rules under which the key can be exported.

Name	Type	Default value	Description
contentType	string	application/json; charset=utf-8	Content type and version of key release policy
data	string		Blob encoding the policy rules under which the key can be released. Blob must be base64 URL encoded.
immutable	boolean		Defines the mutability state of the policy. Once marked immutable, this flag cannot be reset and the policy cannot be changed under any circumstances.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

Share via