POST SecretStore/Add

Adds a new entry in the Secret Store vault.

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

Input parameters

Name

Description

Base64Data

The data to be stored expressed in Base64 format.

Keyname

The name of the Secret Encryption Key (SEK) to used when encrypting this item. Value should be either "Software:Default (formerly known as DPAPI) or Null:Null unless PKCS#11 keys or alternate Software keys have been added after the base installation.

Namespace

The namespace to which the owner belongs.

Owner

The initial owner to which the vault entry belongs, expressed as a Trust Protection Platform distinguished name.

VaultType

Integer representing the type of item being stored. See SecretStore Vault Type.

Returns

Upon success SecretStore/Add 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:

VaultID

The ID of the newly created vault entry.

Example: Add a Secret Store entry

Request

POST https://tpp.venafi.example/vedsdk/SecretStore/Add
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultType":"32",
   "Keyname":"Software:Default",
   "Base64Data":"cGFzc3cwcmQ=",
   "Namespace":"config",
   "Owner":"\\VED\\Policy\\Test"
}

Response

HTTP/1.1 200 OK
{
    "Result": 0,
    "VaultID": 69651
}