POST ConfigSchema/Attributes

Returns all class attribute definitions and the corresponding data type.

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

None.

Returns

Response description

Name

Description

AttributeDefinitions

An array of attribute definitions that are sorted first by Trust Protection Platform, and then by Custom Field attributes, if any.

  • Name: The attribute name. If the attribute is a Custom Field, the value is a GUID. To get the Custom Field name, call POST Config/GuidToDn. See also Metadata Custom Fields API

  • Property: 64. Appears only when the attribute is a Custom Field. Confirms that the attribute is a Custom Field attribute.

  • Syntax: A numeric value that represents the data format or data type. For more information, see ConfigAttribute data types.

Result

Indicates the reason for success or failure. See Config result codes.

Example: Show all Trust Protection Platform and Custom Field attributes

Request

POST https://tpp.venafi.example/vedsdk/ConfigSchema/Attributes
Authorization:Bearer 4MyGeneratedBearerTknz==
{
}

Response

HTTP/1.1 200 OK
{
   "AttributeDefinitions":[
      {
         "Name":"AccessKeyID",
         "Syntax":7
      },
      {
         "Name":"AccountName",
         "Syntax":5
      }, ...
     {
         "Name":"{b65af5ce-5c88-437b-bce1-4ff5585beb02}",
         "Property":64,
         "Syntax":5
         }
   ]
   "Result":1
}