POST Credentials/Delete

Deletes an existing credential.

Requirements

  • Permissions:  The caller must have View permission, Read permission, and Delete permission to the credential object.
  • Token scope:  Security: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

CredentialPath

The path of the credential object to be deleted.

Returns

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Error: Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.
  • Result: Indicates the reason for success or failure. For more information, see Credential result codes.

HTTP 500

For invalid requests, this call returns a HTTP 500 and the following data in the message body:

  • Error: The reason for failure.

  • Success: false: The request was invalid.

Example: Delete password credentials

Request

POST https://tpp.venafi.example/vedsdk/Credentials/Delete
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "CredentialPath":"\\VED\\Policy\\RenamedPasswordCred"
}

Response

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