POST X509CertificateStore/Retrieve

Retrieves a certificate based on the certificate VaultId.

Requirements

Permissions: The caller must have read Read permission to any owner object of the requested Vault ID.
Token scope: Certificate:Manage

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

Input parameters
Name	Description
VaultId	Integer that uniquely identifies the vault entry containing the certificate to retrieve.

Returns

Response description
Name	Description
CertificateString	The Base64-encoded certificate.
Result	A number indicating indicating success 0 or failure. Because this API is a wrapper for SecretStore, see SecretStore result codes.
TypedNameValues	An array of all associated values that correspond to the vault entry. Name: The certificate attribute name. Type: The data type. For example, datetime, integer, or string Value One or more associated values for this vault entry.

Example

Request

POST https://tpp.venafi.example/vedsdk/X509CertificateStore/Retrieve
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultId":683
}

Response

HTTP/1.1 200 OK

{
   "CertificateString":"MIIBMCMA0G...",
   "Result":0,
   "TypedNameValues":[
      {
         "Name":"CN",
         "Type":"string",
         "Value":"Web SDK.Example"
      },
      {
         "Name":"Hash",
         "Type":"string",
         "Value":"444DD0EC268AED3FDBB2BDC096696C710BE0683F"
      },
      {
         "Name":"ValidFrom",
         "Type":"datetime",
         "Value":"10\/10\/2013 18:16:01"
      }
   ]
}