POST Codesign/GetApplicationCollectionMemberDNs

Returns the members of a collection. Collection member include ApplicationDNs and any ApplicationCollectionDNs.

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: DN, Guid, or Id. To get any of these values, call POST Codesign/GetApplicationCollection.

Input parameters

Name

Description

Application

(Optional) The Application object for CodeSign Protect that is currently part of a collection.

Dn

The Distinguished Name (DN) of a set of signing applications. Use this syntax: \\VED\\Code Signing\\Signing Applications\\[SgnApp].

Guid

The GUID that uniquely identifies the signing application.

Id

The signing application 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 description of the ApplicationCollection container.

  • ApplicationCollectionDNs: An array of Application object for CodeSign Protect that describe signing tools.

  • ApplicationDNs:  An array of Application object for CodeSign Protect that describe signing tools.

  • 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: Map a signing application to its collection

Request

POST https://codesign.venafi.example/vedsdk/Codesign/GetApplicationCollectionMemberDNs
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
   },
   "ApplicationCollectionDNs":[

   ],
   "ApplicationDNs":[
      "\\VED\\Code Signing\\Signing Applications\\Powershell - x64",
      "\\VED\\Code Signing\\Signing Applications\\Powershell - x86"
   ],
   "Result":1,
   "Success":true
}