POST SecretStore/LookupAssociationbyVaultID

Returns certificate information from the Secret Store.

This API call only returns the following certificate association attributes: 'Store Archived', 'Store Added', 'Hash', 'Serial', 'Key Algorithm', 'Label', 'Template Major Version', 'Template Minor Version', 'Template Name', and 'Template Oid'. To obtain comprehensive details and validation information for a certificate, please use the Certificates API.

Requirements

Permissions: The caller must have Read permission to the owner.
Token scope: Restricted

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
Name	(Optional) Specify one of the following certificate parameters: Hash: The hash of the certificate. Key Algorithm: The key algorithm of the certificate. Serial: The serial number of the certificate. Template Major Version: Only available if there is a certificate template major version. Template Minor Version: Only available if there is a certificate template version. Template Name: Only available if a friendly template name that issued a certificate. Template Oid: Only available if the certificate originated from a certificate template. The object ID (OID) of the template that issued a certificate.
VaultID	Required. The integer that uniquely identifies the vault entry. To get the correct VaultID, use the POST SecretStore/LookupByOwner method.

Returns

Response description
Name	Description
Result	A number indicating the status: 0: Success. (Failure value): For more information, see SecretStore result codes.
Value	The value that is present in the vault for this certificate.

Example 1: Get the certificate serial number

Request for Example 1

POST https://tpp.venafi.example/vedsdk/SecretStore/LookupAssociationbyVaultID
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultID": "2127",
   "Name": "Serial"
}

Response for Example 1

HTTP/1.1 200 OK
{
   "Result": 0,
   "Value": "16FC49B10002000051B8"
}

Example 2: Get the certificate authority template name

Request for Example 2

POST https://tpp.venafi.example/vedsdk/SecretStore/LookupAssociationbyVaultID
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultID":"2127",
   "Name":"Template Name"
}

Response for Example 2

HTTP/1.1 200 OK
{    
   "Result": 0,
   "Value": "Venafi"
}

Example 3: Get the certificate hash

Request for Example 3

POST https://tpp.venafi.example/vedsdk/SecretStore/LookupAssociationbyVaultID
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultID":"2127",
   "Name":"Hash"
}

Response for Example 3

HTTP/1.1 200 OK
{    
   "Result": 0,    
   "Value": "60447EE534017DF56C22B2C5200D567A3C463F22"
}