POST Codesign/CreateProject

Creates an empty CodeSign Protect Project. After you create the project, use the CodeSign Protect MMC to add environments or POST Codesign/UpdateProject.

  • Signing Project settings are configurable via this REST API and in the VCC.
  • A project can also use settings from the global configuration.
  • After a project is approved, it is ready for code signing.
  • Administrators can monitor signing progress from the Codesigning UI.
  • A project has one or more collections, which are references, about signing applications or tools.
  • A project has one or more Environments and roles which are also known as rights.
  • Each environment references a template. The Environment also has certificates or keys and a signing flow. The signing flow regulates the progress of application signing via a client. For more information, see Flow API.

Signing projects have many components

Requirements

  • Permissions:  None. Projects are created in a Draft state and cannot be used until approved by an administrator.
  • 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

Dn

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

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.

  • Project: A SignProject object that describes the environment's rules, restrictions, users, and approvers.

  • Result: On success, this API call can only create draft projects and the value is 2 InsufficientPermission. Upon administrator approval, the project object is successfully created. On error, an error result is displayed. 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.

  • 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: Create an empty project

Request

POST https://codesign.venafi.example/vedsdk/Codesign/CreateProject
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Dn":"\\VED\\Code Signing\\Projects\\RESTProjectwithSignProject"
}

Response

HTTP/1.1 200 OK
{
   "Project":{
      "ApplicationDNs":{
         "Items":[
            
         ]
      },
      "Applications":[
         
      ],
      "Auditors":{
         "Items":[
            
         ]
      },
      "CSPEnvironments":[
         
      ],
      "CertificateEnvironments":[
         
      ],
      "Collections":[
         
      ],
      "CreatedOn":"/Date(1631810319796)/",
      "CustomFieldAttributes":{
         "Items":[
            
         ]
      },
      "Dn":"\\VED\\Code Signing\\Projects\\RESTProjectwithSignProject",
      "DotNetEnvironments":[
         
      ],
      "GPGEnvironments":[
         
      ],
      "Guid":"{a6f67184-021e-45da-acd6-397d30286131}",
      "Id":648,
      "KeyUseApprovers":{
         "Items":[
            
         ]
      },
      "KeyUsers":{
         "Items":[
            
         ]
      },
      "Owners":{
         "Items":[
            "local:{427d5bf3-00e9-4572-bbfb-cd1ea44838f0}"
         ]
      },
      "Status":2
   },
   "Result":1,
   "Success":true
}