POST Credentials/Rename

Renames a credential.

Requirements

  • Permissions:  The caller must have View permission and Rename permission to the credential object. If the NewCredentialPath specifies a different parent Distinguished Name(DN), the caller must also have Create permission to the new DN.
  • Token scope:  Security: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
CredentialPath The (current) name of the credential to be renamed.
NewCredentialPath The new name to assign to the credential.

Returns

Response description

Name

Description

HTTP 200

Result: Indicates the reason for success or failure. For more information, see Credential result codes.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • error: The reason for the error.
  • error_description: If available, additional information about how to retry the request.

Example: Rename policy credentials

Request

POST https://tpp.venafi.example/vedsdk/Credentials/Rename
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "CredentialPath":"\\VED\\Policy\\Test Password Credential container",
   "NewCredentialPath":"\\VED\\Policy\\Renamed Password Cred container"
}

Response

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