POST Codesign/UpdateProject

Updates CodeSign Protect project and associated environment settings. You can update information about a project even while it is in the draft state. Later, an administrator can approve the 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

Input parameters

Name

Description
Project

The SignProject object. Required fields: Dn, Guid, and Owners.

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

  • Result:  The Result code of this API call. For more information, 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: Add a Key User Approver and Custom Field data to the project

Request

POST https://codesign.venafi.example/vedsdk/UpdateProject
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Project":{
      "CustomFieldAttributes":{
         "Items":[
            {
               "FieldName":"ProjectString",
               "Values":[
                  "ProjectValue: F1018Sometext"
               ]
            }
         ]
      },
      "Dn":"\\VED\\Code Signing\\Projects\\3ProjectDraftwCF",
      "Guid":"{f5dea2fd-73bd-40df-9bda-ce2d1fde0523}",
      "KeyUseApprovers":{
         "Items":[
            "local:{f82b122-8907-4ef9-a8ef-a5625cfa45e4}",
            "local:{45ea2b4f-9c22-4dfe-99b1-c0588016557f}"
         ]
      },
      "Owners":{
         "Items":[
            "local:{5f82b122-8907-4ef9-a8ef-a5625cfa45e4}"
         ]
      }
   }
}

Response

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