Delete Certificate - Delete Certificate

Deletes a certificate from a specified key vault.
Deletes all versions of a certificate object along with its associated policy. Delete certificate cannot be used to remove individual versions of a certificate object. This operation requires the certificates/delete permission.

DELETE {vaultBaseUrl}/certificates/{certificate-name}?api-version=7.0

URI Parameters

Name In Required Type Description
vaultBaseUrl
path True
  • string

The vault name, for example https://myvault.vault.azure.net.

certificate-name
path True
  • string

The name of the certificate.

api-version
query True
  • string

Client API version.

Responses

Name Type Description
200 OK

The deleted certificate.

Other Status Codes

Key Vault error response describing why the operation failed.

Examples

DeleteCertificate

Sample Request

DELETE {vaultBaseUrl}/certificates/importCert01?api-version=7.0

Sample Response

{
  "recoveryId": "https://kv-sdk-test.vault-int.azure-int.net/deletedcertificates/importCert01",
  "deletedDate": 1493938558,
  "scheduledPurgeDate": 1501714558,
  "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "kid": "https://kv-sdk-test.vault-int.azure-int.net/keys/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "sid": "https://kv-sdk-test.vault-int.azure-int.net/secrets/importCert01/f00e72f0ddee4dddadc27c0f605d84d7",
  "x5t": "fLi3U52HunIVNXubkEnf8tP6Wbo",
  "cer": "MIICODCCAeagAwIBAgIQqHmpBAv+CY9IJFoUhlbziTAJBgUrDgMCHQUAMBYxFDASBgNVBAMTC1Jvb3QgQWdlbmN5MB4XDTE1MDQyOTIxNTM0MVoXDTM5MTIzMTIzNTk1OVowFzEVMBMGA1UEAxMMS2V5VmF1bHRUZXN0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA5bVAT73zr4+N4WVv2+SvTunAw08ksS4BrJW/nNliz3S9XuzMBMXvmYzU5HJ8TtEgluBiZZYd5qsMJD+OXHSNbsLdmMhni0jYX09h3XlC2VJw2sGKeYF+xEaavXm337aZZaZyjrFBrrUl51UePaN+kVFXNlBb3N3TYpqa7KokXenJQuR+i9Gv9a77c0UsSsDSryxppYhKK7HvTZCpKrhVtulF5iPMswWe9np3uggfMamyIsK/0L7X9w9B2qN7993RR0A00nOk4H6CnkuwO77dSsD0KJsk6FyAoZBzRXDZh9+d9R76zCL506NcQy/jl0lCiQYwsUX73PG5pxOh02OwKwIDAQABo0swSTBHBgNVHQEEQDA+gBAS5AktBh0dTwCNYSHcFmRjoRgwFjEUMBIGA1UEAxMLUm9vdCBBZ2VuY3mCEAY3bACqAGSKEc+41KpcNfQwCQYFKw4DAh0FAANBAGqIjo2geVagzuzaZOe1ClGKhZeiCKfWAxklaGN+qlGUbVS4IN4V1lot3VKnzabasmkEHeNxPwLn1qvSD0cX9CE=",
  "attributes": {
    "enabled": true,
    "nbf": 1430344421,
    "exp": 2208988799,
    "created": 1493938557,
    "updated": 1493938557,
    "recoveryLevel": "Recoverable+Purgeable"
  },
  "policy": {
    "id": "https://kv-sdk-test.vault-int.azure-int.net/certificates/importCert01/policy",
    "key_props": {
      "exportable": true,
      "kty": "RSA",
      "key_size": 2048,
      "reuse_key": false
    },
    "secret_props": {
      "contentType": "application/x-pkcs12"
    },
    "x509_props": {
      "subject": "CN=KeyVaultTest",
      "ekus": [],
      "key_usage": [],
      "validity_months": 297,
      "basic_constraints": {
        "ca": false
      }
    },
    "lifetime_actions": [
      {
        "trigger": {
          "lifetime_percentage": 80
        },
        "action": {
          "action_type": "EmailContacts"
        }
      }
    ],
    "issuer": {
      "name": "Unknown"
    },
    "attributes": {
      "enabled": true,
      "created": 1493938557,
      "updated": 1493938557
    }
  }
}

Definitions

Action

The action that will be executed.

ActionType

The type of the action.

CertificateAttributes

The certificate management attributes.

CertificatePolicy

Management policy for a certificate.

DeletedCertificateBundle

A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

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.

IssuerParameters

Parameters for the issuer of the X509 component of a certificate.

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.

KeyProperties

Properties of the key pair backing a certificate.

KeyVaultError

The key vault error exception.

LifetimeAction

Action and its trigger that will be performed by Key Vault over the lifetime of a certificate.

SecretProperties

Properties of the key backing a certificate.

SubjectAlternativeNames

The subject alternate names of a X509 object.

Trigger

A condition to be satisfied for an action to be executed.

X509CertificateProperties

Properties of the X509 component of a certificate.

Action

The action that will be executed.

Name Type Description
action_type

The type of the action.

ActionType

The type of the action.

Name Type Description
AutoRenew
  • string
EmailContacts
  • string

CertificateAttributes

The certificate management attributes.

Name Type Description
created
  • integer

Creation time in UTC.

enabled
  • boolean

Determines whether the object is enabled.

exp
  • integer

Expiry date in UTC.

nbf
  • integer

Not before date in UTC.

recoveryLevel

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

updated
  • integer

Last updated time in UTC.

CertificatePolicy

Management policy for a certificate.

Name Type Description
attributes

The certificate attributes.

id
  • string

The certificate id.

issuer

Parameters for the issuer of the X509 component of a certificate.

key_props

Properties of the key backing a certificate.

lifetime_actions

Actions that will be performed by Key Vault over the lifetime of a certificate.

secret_props

Properties of the secret backing a certificate.

x509_props

Properties of the X509 component of a certificate.

DeletedCertificateBundle

A Deleted Certificate consisting of its previous id, attributes and its tags, as well as information on when it will be purged.

Name Type Description
attributes

The certificate attributes.

cer
  • string

CER contents of x509 certificate.

contentType
  • string

The content type of the secret.

deletedDate
  • integer

The time when the certificate was deleted, in UTC

id
  • string

The certificate id.

kid
  • string

The key id.

policy

The management policy.

recoveryId
  • string

The url of the recovery object, used to identify and recover the deleted certificate.

scheduledPurgeDate
  • integer

The time when the certificate is scheduled to be purged, in UTC

sid
  • string

The secret id.

tags
  • object

Application specific metadata in the form of key-value pairs

x5t
  • string

Thumbprint of the certificate.

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
Purgeable
  • string
Recoverable
  • string
Recoverable+ProtectedSubscription
  • string
Recoverable+Purgeable
  • string

Error

The key vault server error.

Name Type Description
code
  • string

The error code.

innererror

The key vault server error.

message
  • string

The error message.

IssuerParameters

Parameters for the issuer of the X509 component of a certificate.

Name Type Description
cert_transparency
  • boolean

Indicates if the certificates generated under this policy should be published to certificate transparency logs.

cty
  • string

Certificate type as supported by the provider (optional); for example 'OV-SSL', 'EV-SSL'

name
  • string

Name of the referenced issuer object or reserved names; for example, 'Self' or 'Unknown'.

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 not exportable from the HSM.

RSA
  • string

RSA (https://tools.ietf.org/html/rfc3447)

RSA-HSM
  • string

RSA with a private key which is not exportable from the HSM.

oct
  • string

Octet sequence (used to represent symmetric keys)

KeyProperties

Properties of the key pair backing a certificate.

Name Type Description
crv

Elliptic curve name. For valid values, see JsonWebKeyCurveName.

exportable
  • boolean

Indicates if the private key can be exported.

key_size
  • integer

The key size in bits. For example: 2048, 3072, or 4096 for RSA.

kty

The type of key pair to be used for the certificate.

reuse_key
  • boolean

Indicates if the same key pair will be used on certificate renewal.

KeyVaultError

The key vault error exception.

Name Type Description
error

The key vault server error.

LifetimeAction

Action and its trigger that will be performed by Key Vault over the lifetime of a certificate.

Name Type Description
action

The action that will be executed.

trigger

The condition that will execute the action.

SecretProperties

Properties of the key backing a certificate.

Name Type Description
contentType
  • string

The media type (MIME type).

SubjectAlternativeNames

The subject alternate names of a X509 object.

Name Type Description
dns_names
  • string[]

Domain names.

emails
  • string[]

Email addresses.

upns
  • string[]

User principal names.

Trigger

A condition to be satisfied for an action to be executed.

Name Type Description
days_before_expiry
  • integer

Days before expiry to attempt renewal. Value should be between 1 and validity_in_months multiplied by 27. If validity_in_months is 36, then value should be between 1 and 972 (36 * 27).

lifetime_percentage
  • integer

Percentage of lifetime at which to trigger. Value should be between 1 and 99.

X509CertificateProperties

Properties of the X509 component of a certificate.

Name Type Description
ekus
  • string[]

The enhanced key usage.

key_usage
  • string[]

List of key usages.

sans

The subject alternative names.

subject
  • string

The subject name. Should be a valid X509 distinguished Name.

validity_months
  • integer

The duration that the certificate is valid in months.