POST X509CertificateStore/Remove

Removes one or more certificate entries from the certificate vault.

Requirements

  • Permissions:  The caller must have Write permission to the requested Owner object.
  • Token scope:  Restricted:Delete

Headers

  • Content type: Content-Type:application/json.

  • Token: The bearer access token that you received. For example, Authorization:Bearer 4MyGeneratedBearerTknz==. For more information, see Passing a bearer token in your API calls.

Parameters

In addition to the required OwnerDN, specify either VaultId or Certificate.

Input parameters

Name

Description

Certificate (Optional)

The Base64-encoded certificate to remove.

OwnerDN

Also known as the Owner object. The owner of the certificate to remove.

VaultId (Optional)

The ID of the vault where the certificate to remove resides.

Returns

Response description

Name

Description

A number indicating indicating success 0 or failure. Because this API is a wrapper for SecretStore, see SecretStore result codes. If the certificate has more than one owner, only the owner reference is removed. When the last owner reference is removed, the certificate is removed from the vault.

Example

Request

POST https://tpp.venafi.example/vedsdk/X509CertificateStore/Remove
Authorization:Bearer 4MyGeneratedBearerTknz==
{  
   "VaultId":683,
   "OwnerDN":"\\VED\\Policy\\folder\\TestCert"
}

Response

HTTP/1.1 200 OK
{  
   "Result":0
}