POST Config/ContainableClasses

Returns a list of schema class names that can be created subordinate to an object.

Requirements

  • Permissions:  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 Object DN to examine for possible subordinate classes.

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:

  • ClassNames: An array of class names that can be created as children of the object.
  • Error: Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.
  • 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: Get schema class names from a container class

Request

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

Response

HTTP/1.1 200 OK
{
   "ClassNames":[
      "Policy",
      "CertificateAuthorityBase",
      "JumpServer",
      "Workflow",
      "Device",
      "X509RootCertificate",
      "X509IntermediateRootCertificate"
   ],
   "Result":1
}