POST Codesign/GetProject

Returns information about a Venafi CodeSign Protect project. The project shows environments details like approvers and custom fields that appear in the API.

Requirements

  • Permissions: The caller must be a Code Signing Administrator or a member of any role on the project.
  • Token scope:  Codesign

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 one of the following parameters.

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.

Returns

For valid requests, GetProject 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.

Project:A SignProject object that describes the environments rules, restrictions, users and approvers.

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: Find information about a signing project

Request

POST https://codesign.venafi.example/vedsdk/Codesign/GetProject
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Guid":"{b1479882-1bba-4939-9e02-4c3367d0f75e}"
}

Response

HTTP/1.1 200 OK
{
   "Project":{
      "ApplicationDNs":{
         "Items":[
            
         ]
      },
      "Applications":[
         
      ],
      "Auditors":{
         "Items":[
            
         ]
      },
      "CSPEnvironments":[
         
      ],
      "CertificateEnvironments":[
         
      ],
      "Collections":[
         
      ],
      "CreatedOn":"/Date(1631132816123)/",
      "CustomFieldAttributes":{
         "Dirty":true,
         "Items":[
            {
               "FieldName":"CFManualPrj",
               "Values":[
                  
               ]
            },
            {
               "FieldName":"ProjectString",
               "Values":[
                  "ProjectValue: F1018Sometext"
               ]
            }
         ]
      },
      "Dn":"\\VED\\Code Signing\\Projects\\3ProjectDraftwCF",
      "DotNetEnvironments":[
         
      ],
      "GPGEnvironments":[
         
      ],
      "Guid":"{f5dea2fd-73bd-40df-9bda-ce2d1fde0523}",
      "Id":729,
      "KeyUseApprovers":{
         "Items":[
            "local:{f82b122-8907-4ef9-a8ef-a5625cfa45e4}",
            "local:{45ea2b4f-9c22-4dfe-99b1-c0588016557f}"
         ]
      },
      "KeyUsers":{
         "Items":[
            
         ]
      },
      "Owners":{
         "Items":[
            "local:{5f82b122-8907-4ef9-a8ef-a5625cfa45e4}"
         ]
      },
      "Status":2
   },
   "Result":1,
   "Success":true
}