POST Config/FindContainers

Returns a list of all subordinate objects for a parent object.

Requirements

  • Permissions:  The caller must have View permission to objects in order for them to appear in the results.
  • 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 Distinguished Name (DN) of the object under which to look for subordinates.

Recursive (Optional)

When set to 1, subordinates of subordinates should also be returned.

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 found objects:

    • 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: Find subordinate folders for a DN

Request

POST https://tpp.venafi.example/vedsdk/Config/FindContainers
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\folder"
}

Response

HTTP/1.1 200 OK
{
   "Objects":[
      {
         "AbsoluteGUID":"{72c1add5}{e3be4130}{ee684cfd}{73480380}{4e14b7}",
         "DN":"\\VED\\Policy\\folder\\Device2\\Basic2",
         "GUID":"{4e14b7}",
         "Name":"Basic2",
         "Parent":"\\VED\\Policy\\folder\\Device2",
         "TypeName":"Basic"
      },
      {
         "AbsoluteGUID":"{72c1add5}{e3be4130}{ee684cfd}{73480380}{9734d3}",
         "DN":"\\VED\\Policy\\folder\\Device2\\Basic3",
         "GUID":"{9734d3}",
         "Name":"Basic3",
         "Parent":"\\VED\\Policy\\folder\\Device2",
         "TypeName":"Basic"
      }
   ]
}