GET Metadata/Items

Returns every Custom Field.

Requirements

  • Permissions:  The caller is not required to have any special permissions to successfully invoke this method.
  • 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

Items

An array of Metadata Item settings that are present in the DN. 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: Show custom metadata

Request

GET https://tpp.venafi.example/vedsdk/Metadata/Items 
Authorization:Bearer 4MyGeneratedBearerTknz==

Response

HTTP/1.1 200 OK        
{
   "Items":[
      {
         "AllowedValues":[
            "Device1",
            "Device2"
         ],
         "Classes":[
            "Device"
         ],
         "ConfigAttribute":"{54baa4a0-474a-49be-885b-5a88f7971c26}",
         "DN":"\\VED\\Metadata Root\\3e1bdc43-041f-4787-851b-e937972b1fdf",
         "DefaultValues":[

         ],
         "Guid":"{54baa4a0-474a-49be-885b-5a88f7971c26}",
         "Help":"Select a device",
         "Label":"CF-Device",
         "Name":"3e1bdc43-041f-4787-851b-e937972b1fdf",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":2
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate"
         ],
         "ConfigAttribute":"{24cb39d4-33ce-4d08-ade4-81d6b293551c}",
         "DN":"\\VED\\Metadata Root\\db1e5711-2bd0-45da-be4a-2c9e0baf4637",
         "DefaultValues":[

         ],
         "ErrorMessage":"Type the reason",
         "Guid":"{24cb39d4-33ce-4d08-ade4-81d6b293551c}",
         "Help":"Reason for certificate renewal",
         "Label":"CF-ReviewReason",
         "Name":"db1e5711-2bd0-45da-be4a-2c9e0baf4637",
         "Policyable":false,
         "RegularExpression":"^[A-Za-z0-9]*$",
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      },
      {
         "AllowedValues":[

         ],
         "Classes":[
            "X509 Certificate",
            "Policy",
            "Device"
         ],
         "ConfigAttribute":"{e3169cbc-c7c5-44cc-ae7a-879cc33853dc}",
         "DN":"\\VED\\Metadata Root\\MetaDataObject_011618050105703",
         "DefaultValues":[

         ],
         "Guid":"{e3169cbc-c7c5-44cc-ae7a-879cc33853dc}",
         "Label":"MetaDataTest 011618050105703",
         "Name":"MetaDataObject_011618050105703",
         "Policyable":false,
         "RenderHidden":false,
         "RenderReadOnly":false,
         "Type":1
      }
   ],
   "Locked":false,
   "Result":0
}