POST ConfigSchema/Class

Returns a class definition. To get the full class definition, you use the superclass names in the response to make additional ConfigSchema/Class calls.

Requirements

  • Permissions:  The caller is not required to have any special permissions.
  • Token scope:   Any valid scope, such as Agent, Certificate, or SSH

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

Class

The name of the class. For more information, see How to find class names and attributes.

Returns

Response description

Name

Description

ClassDefinition

The class definition for the specific class.

Result

Indicates the reason for success or failure. For more information, see Config result codes.

Example: Show a class definition

Request

POST https://tpp.venafi.example/vedsdk/ConfigSchema/Class
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Class":"Comodo CCM"
}

Response

HTTP/1.1 200 OK
{
   "ClassDefinition":{
      "ContainmentNames":[

      ],
      "ContainmentSubNames":[

      ],
      "MandatoryNames":[

      ],
      "Name":"Comodo CCM",
      "NamingNames":[

      ],
      "OptionalNames":[
         "Customer Login URI",
         "Organization",
         "Secret Key"
      ],
      "SuperClassNames":[
         "Certificate Authority Base"
      ]
   },
   "Result":1
}