POST Config/RenameObject

Renames or moves an object. Renaming is accomplished by changing the leaf name of the Object DN. Moving can be accomplished by changing the path of the DN.

Requirements

  • Permissions:  The caller must have Rename permission to the existing object and Create permission to the parent of the object.
  • Token scope:  Configuration: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

ObjectDN

The (current) DN of the object that is to be renamed or moved.

NewObjectDN

The new DN to assign to the object.

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: The result code that indicates the reason for success or failure. For more information, see Config result codes.

HTTP 400

For invalid requests, this call returns a HTTP 400 BadRequest 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 a DN

Request

POST https://tpp.venafi.example/vedsdk/Config/RenameObject
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\folder\\Device2\\Basic2",
   "NewObjectDN":"\\VED\\Policy\\folder\\Device1\\Basic2"
}

Response

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