POST Metadata/GetPolicyItems

Important! This page is no longer supported or being updated. It is left here for reference purposes. We encourage you to find corresponding information in our new API Reference documentation.

Returns policy-assigned values for Custom Fields.

Requirements

  • Permissions:  The caller must have View permission to the Distinguished Name (DN) of the Policy.
  • 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

DN

The Distinguished name (DN) of a policy folder that has values for at least one Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response.

Returns

Response description

Name

Description

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.

PolicyItems

An array of key-value pairs where the Key is the object class and the value is an array of settings for the Metadata Item .

Result

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

Example

Request

POST https://tpp.venafi.example/vedsdk/Metadata/GetPolicyItems
Authorization:Bearer 4MyGeneratedBearerTknz==
{
  "DN": "\\VED\\Policy"
}

Response

HTTP/1.1 200 OK
{
   "Locked":false,
   "PolicyItems":[
      {
         "Key":"X509 Certificate",
         "Value":[
            {
               "AllowedValues":[
                  "Operations",
                  "Engineering",
                  "Pre-Sales"
               ],
               "Classes":[
                  "X509 Certificate"
               ],
               "ConfigAttribute":"{ad6f7b22-b67f-404b-83fb-28823743b2d2}",
               "DN":"\\VED\\Metadata Root\\d9c040ab-f9af-407d-8e8f-1ad921753f60",
               "DefaultValues":[

               ],
               "Guid":"{ad6f7b22-b67f-404b-83fb-28823743b2d2}",
               "Label":"Operational Division",
               "Mandatory":true,
               "Name":"d9c040ab-f9af-407d-8e8f-1ad921753f60",
               "Policyable":true,
               "RenderHidden":false,
               "RenderReadOnly":false,
               "Type":2
            }
         ]
      }
   ],
   "Result":0
}