POST Codesign/EnumerateApplicationCollections

Returns information about every signing application collection.

Requirements

  • Permissions:  None. Anyone can view application collections.
  • 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

Input parameters

Name

Description

Filter

(Optional) The partial tool name and optional trailing asterisk (*) wild card. For example, Sign*.

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:

  • ApplicationCollections: An array of ApplicationCollection object.

  • 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: List all signing tool collections by DN

Request

POST https://codesign.venafi.example/vedsdk/Codesign/EnumerateApplicationCollections
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Filter": "Sign*"
}

Response

HTTP/1.1 200 OK
{
   "ApplicationCollections":[
      {
         "ApplicationDNs":{
            "Items":[
               "\\VED\\Code Signing\\Signing Applications\\Signtool
		   - v7.1A",
               "\\VED\\Code Signing\\Signing Applications\\Signtool
		 - 10.0.17134.0 - x64",
               "\\VED\\Code Signing\\Signing Applications\\Signtool
		 - 10.0.17134.0 - x86",
               "\\VED\\Code Signing\\Signing Applications\\Signtool
		 - 8.1 - x64",
               "\\VED\\Code Signing\\Signing Applications\\Signtool
		 - 8.1 - x86"
            ]
         },
         "Dn":"\\VED\\Code Signing\\Signing Applications\\Signtool",
         "Guid":"{7efa5cf0-8630-454c-bc52-6d2340b9c7b3}",
         "Id":403
      },
      {
         "ApplicationDNs":{
            "Items":[
               "\\VED\\Code Signing\\Signing Applications\\Jarsigner - 8",
               "\\VED\\Code Signing\\Signing Applications\\Jarsigner - 11"
            ]
         },
         "Dn":"\\VED\\Code Signing\\Signing Applications\\Jarsigner",
         "Guid":"{dc709aca-6a07-4ab7-961e-9cb8b6e4fa6a}",
         "Id":406
      },
      {
         "ApplicationDNs":{
            "Items":[
               "\\VED\\Code Signing\\Signing Applications\\Powershell
		 - x64",
               "\\VED\\Code Signing\\Signing Applications\\Powershell
		 - x86"
            ]
         },
         "Dn":"\\VED\\Code Signing\\Signing Applications\\Powershell",
         "Guid":"{e17b907c-9865-4402-ba1f-c79df84548ee}",
         "Id":409
      },
      {
         "ApplicationDNs":{
            "Items":[
               "\\VED\\Code Signing\\Signing Applications\\Signtool",
               "\\VED\\Code Signing\\Signing Applications\\Jarsigner",
               "\\VED\\Code Signing\\Signing Applications\\Powershell"
            ]
         },
         "Dn":"\\VED\\Code Signing\\Signing Applications\\Windows",
         "Guid":"{0a2e6ccf-06d7-4792-a0c3-6e63e36e2f9d}",
         "Id":410
      }
   ],
   "Result":1,
   "Success":true
}