POST SecretStore/OwnerDelete

Removes an owner from one or all vault entries.

If OwnerDelete is used to remove the last owner of a vault entry, the vault entry will be deleted. To prevent the vault entry from being deleted, add a new owner before removing the existing owner (if that owner is the last remaining owner).

Requirements

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

Input parameters

Name

Description

Namespace

The software namespace to use for this API method. For example config.

Owner

The distinguished name (DN) of the owner.

VaultID (Optional)

The integer that uniquely identifies the vault entry that requires owner removal. If no VaultID is specified, the owner will be removed from all vault entries it is listed on as owner. If necessary, call POST Config/Read or POST SecretStore/LookupByOwner to get the Vault IDs.

Returns

Upon success SecretStore/OwnerDelete 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/OwnerDelete
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "VaultID":376,
   "Namespace":"config",
   "Owner":"\\VED\\Policy\\AnotherCredential"
}

Response

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