POST SecretStore/Associate

Associates a name/value pair with the specified vault entry.

Requirements

  • Permissions: The caller must have Write permission to the owner.
  • Token scope:  Restricted: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

At least one of the optional parameters is required and only one will be honored by SecretStore/Associate.

Input parameters

Name

Description

DateValue (Optional)

The date/time to be stored. Use Universal Time Coordinated (UTC) in the ISO 8601 format, for example YYYY-MM-DDTHH:MM:SS.mmmmmmmZ.

IntValue (Optional)

The number to be stored.

Name

The name of the value to be stored.

StringValue (Optional)

The string value to be stored.

VaultID

The integer which uniquely identifies the vault entry.

Returns

Upon success SecretStore/Associate returns a HTTP 200 message. If successful, the event information appears in the Trust Protection Platform log.

Response description

Name

Description

Result

A number indicating the status:

Example

Request

POST https://tpp.venafi.example/vedsdk/SecretStore/Associate
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultID":376,
   "Name":"Purpose",
   "StringValue":"Access to endpoint"
}

Response

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