POST Codesign/CreateApplicationCollection

Creates a new blank signing application collection. An application collection is a set of signing tools. For example, the collection can group the most commonly used tools. The new collection appears in the Signing Applications node of VCC. To add signing tools, call POST Codesign/UpdateApplicationCollection.

NOTE  The collection only appears in VCC after you right-click the Venafi Code Signing node and select refresh.

Requirements

  • Permissions: 

    The caller must be a Code Signing Administrator or application administrator.

  • Token scope:  Codesign:Manage

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

Dn

The Distinguished Name (DN) of the new signing collection. Use this syntax: \\VED\\Code Signing\\Signing Applications\\[collection name].

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 ApplicationCollection that holds this member.

  • 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: Add a new category of application sigining tools

Request

POST https://codesign.venafi.example/vedsdk/Codesign/CreateApplicationCollection
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Dn": "\\VED\\Code Signing\\Signing Applications\\MyCollection"
}

Response

HTTP/1.1 200 OK
{
   "ApplicationCollection":{
      "ApplicationDNs":{
         "Items":[

         ]
      },
      "Dn":"\\VED\\Code Signing\\Signing Applications\\MyCollection",
      "Guid":"{3bbb17d1-e8d4-4d96-894f-acc65b0862b0}",
      "Id":422
   },
   "Result":1,
   "Success":true
}