POST Codesign/GetApplicationCollection

Returns information about a signing application collection. Application collections appear in the Signing Applications node of VCC.

Location of application collections that hold signing application information

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

Specify one of the following. To get any of these values, call POST Codesign/EnumerateApplicationCollections.

Input parameters

Name

Description

Dn

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

Guid

The GUID that uniquely defines a collection of signing tools.

ID

The application collection identifier.

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:

  • ApplicationCollection: The set of application signing tools that are present in theApplicationCollection 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 the signing tools that are present in an Application collection

Request

POST https://codesign.venafi.example/vedsdk/Codesign/GetApplicationCollection
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Dn":"\\VED\\Code Signing\\Signing Applications\\Powershell",
   "Guid":"{e17b907c-9865-4402-ba1f-c79df84548ee}",
   "Id":409
}

Response

HTTP/1.1 200 OK
{
   "ApplicationCollection":{
      "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
   },
   "Result":1,
   "Success":true
}