POST Metadata/GetItemsForClass

Returns an array of Custom Fields and their attributes that apply to the specified object class.

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

ConfigClass

An object name:

  • Code Signing Environment Base: Show the Custom Fields for Project Environments.

  • Code Signing Project: Show the Custom Fields for the Project.

  • Device: Show Custom Fields for Devices.
  • Policy:  Show the Custom Fields in the Policy.
  • X509 Certificate: Show the Custom Fields for Certificates.

Returns

Response description

Name

Description

Items

An array of Metadata Item settings that are present in the Distinguished Name (DN). If a setting is missing, the value is not set. Each array element describes a Custom Field.

Locked

The status of the data:

  • true: The Policy value, which applies to the Custom Field, is locked.
  • false: The Custom Field value is capable of change.

Result

The reason for success or failure. For more information, see Metadata Result Codes.

Example: List policy values for X509 certificates

Request

POST https://tpp.venafi.example/vedsdk/Metadata/GetItemsForClass
Authorization:Bearer 4MyGeneratedBearerTknz==
{   
   "ConfigClass": "X509 Certificate"
}

Response

HTTP/1.1 200 OK
{
   "Items": [
    {
      "AllowedValues": "Development Test Production",
      "Classes": ["X509 Certificate"],
      "ConfigAttribute": "{25876f6c-cb8a-4b02-8475-bc3de9ecf3ba}",
      "DN": "\\VED\\Metadata Root\\f835fd76-48f9-4b27-b2a6-1c17bb0dfb12",
      "DefaultValues": [],
      "ErrorMessage": "Invalid value",
      "Guid": "{25876f6c-cb8a-4b02-8475-bc3de9ecf3ba}",
      "Help": "Help Text", 
      "Label": "Operating Environment"
      "Mandatory":  true,
      "Name": "f835fd76-48f9-4b27-b2a6-1c17bb0dfb12",
      "Policyable": false,
      "RegularExpression": "^[a-zA-Z0-9_\\.\\+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-\\.]+$",
      "RenderHidden": false,
      "RenderReadOnly": false,
      "Type": 2
      },
      {
       "AllowedValues": "Development Test Production",
        "Classes":  "X509 Certificate",
        "ConfigAttribute":  "{163056e8-0657-4109-9204-50b397b246e1}",
        "DN":  "\\VED\\Metadata Root\\Hidden Object Name",
        "DefaultValues": [],
        "ErrorMessage": "Invalid value",
        "Guid":  "{163056e8-0657-4109-9204-50b397b246e1}",
        "Help": "Cost Center is comprised of 3 letters followed by 3 numbers"
        "Label":  "Cost Center",
        "Mandatory":  true,
        "Name":  "Hidden Object Name",
        "Policyable":  true,
        "RegularExpression": "^[a-zA-Z0-9_\\.\\+-]+@[a-zA-Z0-9-]+\\.[a-zA-Z0-9-\\.]+$",
        "RenderHidden": false,
        "RenderReadOnly": false,
        "Type":  1
        }
      ],
   "Locked": false,
   "Result": 0
}