POST Codesign/RenameProject

Renames a CodeSign Protect project.

Requirements

  • Permissions: 

    The caller must be a Code Signing Administrator, or a Owner.

  • Token scope:  Codesign: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

Specify either Dn, Guid or Id.

Input parameters

Name

Description

Dn

(Optional) The Distinguished Name (DN) of the signing project. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Projects\\[YourPrjName].

Guid

(Optional)The GUID that uniquely identifies the signing project.

Id

(Optional)The signing project identifier.

NewDn

Required. The DN of the signing project. Use this syntax: "Dn": "\\VED\\Code Signing\\Projects\\[ProjectName].

Returns

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

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 Success is false. An error message that accompanies the Result. Check your payload input values.

  • Result:On success, this API call can only create draft projects and the value is 2 InsufficientPermission. Upon administrator approval, the project object successfully creates. On error, see Sign Result Codes

  • Success: The result of this API call: A value of false indicates the request failed due to an Error. Otherwise, true.

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 a project

Request

POST https://codesign.venafi.example/vedsdk/Codesign/RenameProject
Authorization:Bearer 4MyGeneratedBearerTknz==
{
  "Dn": "\\VED\\Code Signing\\Projects\\APIProjectDraft",
  "NewDn": "\\VED\\Code Signing\\Projects\\Lab 4"
}

Response

HTTP/1.1 200 OK
{
  "Result": 1,
  "Success": true
}