POST Codesign/EnumerateProjects

Returns details about Venafi CodeSign Protect projects.

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

Either pass no parameters or specify one of the following:

Input parameters

Name

Description

(none) 

Returns all signing projects.
Filter (Optional) A simple filter on the Project name.
Rights (Optional) Show only projects for which the caller has a minimum set of permissions. For example, show only projects to which the caller is the owner. For more information, see SignRight 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: A error message that accompanies the Result.

  • Projects: An array of SignProject objects that describe environment's 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: List any projects in which the caller has administrator rights

TIP  If you need a project GUID and Id for managing environments, carefully parse the response. Many GUIDs and IDs identify environments, signing tools, and other aspects of the project.

 

Request

POST https://codesign.venafi.example/vedsdk/Codesign/EnumerateProjects
Authorization:Bearer 4MyGeneratedBearerTknz==  
{
    "Rights": 1

}

Response

HTTP/1.1 200 OK{
    "Projects": [
        {
            "ApplicationDNs": {
                "Items": []
            },
            "Applications": [],
            "Auditors": {
                "Items": [
                    "local:{4b05eb54-9a8f-4031-a7b0-86616d9996d2}"
                ]
            },
            "CSPEnvironments": [...],
            "CertificateEnvironments": [...]
            ],
            "Collections": [
                {
                    "ApplicationDNs": {
                        "Items": [
                            "\\VED\\Code Signing\\Signing Applications\\Signtool - v7.1A"
                        ]
                    },
                    "Dn": "\\VED\\Code Signing\\Signing Applications\\Signtool",
                    "Guid": "{f014ba62-5a6d-4cb5-8e4b-f96946fe9f98}",
                    "Id": 825108
                }
            ],
            "CreatedOn": "/Date(1612386280272)/",
            "CustomFieldAttributes": {
                "Items": []
            },
            "Description": "Your first code signing project",
            "Dn": "\\VED\\Code Signing\\Projects\\Sample",
            "DotNetEnvironments": [],
            "GPGEnvironments": [],
            "Guid": "{ab91551d-47cd-431a-b4a6-3e48d325a1dc}",
            "Id": 825089,
            "KeyUseApprovers": {
                "Items": [
                    "local:{8b5dffce-6fe0-4d5c-bb32-f3204c030b28}"
                ]
            },
            "KeyUsers": {
                "Items": [
                    "local:{a5c0c39f-22d9-42d0-bf24-310b7bf31849}"
                ]
            },
            "Owners": {
                "Items": [
                    "local:{e71587f3-65c9-4444-b0b6-c9b1f581d00e}"
                ]
            },
            "Status": 1
        },
        {
            "ApplicationDNs": {...}
        }
    ],
    "Result": 1,
    "Success": true
}