POST Config/Enumerate

Returns a list of all subordinate Config objects for a specified folder.

Requirements

  • Permissions:  In order for the enumeration to work properly, the caller must have View permission to the requested object.
  • Token scope:  Configuration

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

ObjectDN

The policy folder with subordinate objects.

Recursive (Optional)

The amount of detail to return:

true: List the parent and all matching subordinate objects from subordinate folders.

false: List only parent objects.

Pattern

An expression for filtering DN matches:

  • To list DNs that include an asterisk (*) or question mark (?), prepend two backslashes (\\). For example, \\*.MyCompany.net treats the asterisk as a literal character and returns only certificates with DNs that match *.MyCompany.net.
  • To list DNs with a wildcard character, append a question mark (?). For example, "test_?.mycompany.net" counts test_1.MyCompany.net and test_2.MyCompany.net but not test12.MyCompany.net.
  • To list DNs with similar names, prepend an asterisk. For example, *est.MyCompany.net, counts Test.MyCompany.net and West.MyCompany.net.

  • You can also use both literals and wildcards in a pattern.

    NOTE  Web SDK wildcards operate differently than the UI wildcards. For REST API calls, be sure to follow the guidelines stated in this section.

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:

  • Error: Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.

  • Objects: An array of object details:

    • AbsoluteGUID: The left-to-right concatenation of all of the GUIDs for all of the objects in the DN.
    • DN: The Distinguished Name (DN) of the object.
    • GUID: The GUID that identifies the object.
    • ID: The object identifier.
    • Name: The Common Name (CN) of the object.
    • Parent: The parent DN of the object.
    • Revision: The revision of the object.
    • TypeName: the class name of the object.
  • Result: The result code that indicates the reason for success or failure. For more information, see Config result codes.

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 subordinate Config objects for a policy folder

Request

POST https://tpp.venafi.example/vedsdk/Config/Enumerate
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\Top Level\\Lab A\\",
   "Pattern":"*est.MyCompany.net"
}

Response

HTTP/1.1 200 OK
{
   "Objects":[
      {
         "AbsoluteGUID":"{a6692653-...}{425ad54b-...}{066ceff9-...}{78a66d22-...}",
         "DN":"\\VED\\Policy\\TopLevel\\LabA\\Test.MyCompany.net",
         "GUID":"{15dd6264-dcb2-49ce-97a5-bb89ffd0dedf}",
         "Id":1068,
         "Name":"Test.MyCompany.net",
         "Parent":"\\VED\\Policy\\TopLevel\\LabA",
         "Revision":1782188,
         "TypeName":"X509 Server Certificate"
      },
      {
         "AbsoluteGUID":"{a6692653-...}{425ad54b-...}{066ceff9-...}{78a66d22-...}{7c7dfcd1-...}",
         "DN":"\\VED\\Policy\\TopLevel\\LabA\\West.MyCompany.net",
         "GUID":"{7c7dfcd1-6bfc-4366-8ee1-77c8e2bda62c}",
         "Id":1067,
         "Name":"West.MyCompany.net",
         "Parent":"\\VED\\Policy\\TopLevel\\LabA",
         "Revision":10175,
         "TypeName":"X509 Server Certificate"
      }
   ],
   "Result":1
}