POST Metadata/GetItemGuids

Returns an array of GUIDs for all of the Custom Fields that apply to the specified object.

Requirements

  • Permissions:  The caller must have View permission to the Distinguished Name (DN) of a certificate or device in the request.
  • 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 Certificate or Device object that contains a Custom Field. If necessary, use the DN value from the GET Metadata/Items or POST Metadata/GetItemsForClass response.

Returns

Response description

Name

Description

ItemGuids

An array of GUIDs, one for every Custom Field applied to the object. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

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: Get a Certificate DN GUID

Request

POST https://tpp.venafi.example/vedsdk/Metadata/GetItemGuids
Authorization:Bearer 4MyGeneratedBearerTknz==
{   
   "DN": "\\VED\\Policy\\Certificates\\www.company.com"
} 

Response

HTTP/1.1 200 OK
{
   "ItemGuids":[
      "{a80714f0-565c-4bc2-9026-787cf076d764}",
      "{8942f858-6b02-4ad2-b76a-9f460b0e7c11}",
      "{daf6fb5d-3de6-4ca1-b821-b937817b6f84}",
      "{25876f6c-cb8a-4b02-8475-bc3de9ecf3ba}",
      "{1d3ea83e-59f4-4bd6-ac22-07bf0c078d94}"
   ],
   "Locked":false,
   "Result":0
}