POST Codesign/EnumerateReferences

Returns the location of a signing application or collection of signing tools.

Requirements

  • Permissions:  None.
  • 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.

Input parameters

Name

Description
Application

Show the location of a signing application. Specify both. To get these values, call POST Codesign/GetApplication.

  • Dn: The Distinguished Name (DN) of the signing application.
  • Guid: The GUID that uniquely identifies the signing application.

ApplicationCollection

Show the location of an application collection.

Dn of the signing collection. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]. To get the value, call POST Codesign/EnumerateApplicationCollections.

Guid: The GUID that uniquely defines a collection of signing tools.

ApplicationDn

Show the location of a signing application. Specify the DN of the signing application. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Signing Applications\\[YourSgnApp]. To get the value, call POST Codesign/GetApplication.

ApplicationGuid

Show the location of a signing application. Specify the GUID that uniquely identifies the signing application. To get t The GUID that uniquely identifies the signing application. The value, call POST Codesign/GetApplication.

CollectionDn

Show the location of an application collection. Specify just the application collection DN. Use the appropriate syntax. For example, in Postman: \\VED\\Code Signing\\Signing Applications\\[YourSgnAppCollection]. To get the value, call POST Codesign/EnumerateApplicationCollections.

CollectionGuid

The GUID that uniquely identifies a set of application signing tools. To get the value, call POST Codesign/EnumerateApplicationCollections.

Returns

Response description

Name

Description

Error

Appears only when Success is false. An error message that accompanies the Result. Check your payload input values.

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.

  • Result: The Result code of this API call. For more information, see Sign Result Codes.

  • ReferenceDNs: An array of DNs of the application or ApplicationCollection that describes signing tools.

  • 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: Show the container that holds a Signtool

Request

POST https://codesign.venafi.example/vedsdk/EnumerateReferences
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Application":{
      "Dn":"\\VED\\Code Signing\\Signing Applications\\Signtool - v7.1A",
      "Guid":"{8f168386-0136-44b2-8bda-43327a7aa2c1}"
   }
}

Response

HTTP/1.1 200 OK
{
   "ReferenceDNs":[
      "\\VED\\Code Signing\\Signing Applications\\Signtool"
   ],
   "Result":1,
   "Success":true
}