POST Metadata/Find

Returns all objects with a value stored for a particular Custom Field.

Requirements

  • Permissions:  The caller must have Read permission to the Distinguished Name (DN) of a certificate or device that contains a Custom Field value. Otherwise, the object does not appear in the results.
  • 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

Specify either Item or ItemGuid.

Input parameters

Name

Description

Item (Optional)

The GUID of a certificate or device that identifies the Custom Field. To get the Custom Field GUID, use POST Metadata/GetItems. Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

Item Guid (Optional)

The globally unique identifier of a Custom Field.

Depending on your environment, the GUID may be expressed with or without curly braces {}. For example, {3d6b61d-1c71-4603-883f-25b8c2ceecdd}.

Value (Optional)

String that focuses the search on a particular value of the Custom Field.

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.

Objects

An array of ConfigObjects.

Result

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

Example: Find the Value of a Custom Field

Request

Copy

Request

POST https://tpp.venafi.example/vedsdk/Metadata/Find
Authorization:Bearer 4MyGeneratedBearerTknz==
{   
   "ItemGuid": "{a80714f0-565c-4bc2-9026-787cf076d764}"
}

Response

Copy

Response

HTTP/1.1 200 OK
{
   "Locked":false,
   "Objects":[
      {
         "AbsoluteGUID":"{1f57776d...} {da985a3f...}{ae4d5eca...}",
         "DN":"\\VED\\Policy\\Certificates\\mail.company.com",
         "GUID":"{4f17dd2a-e26b-48c6-bc71-fefb864760e3}",
         "Name":"mail.company.com",
         "Parent":"\\VED\\Policy\\Certificates",
         "Revision":635349428903212178,
         "AttributeList":"{a80714f0-565c-4bc2-9026-787cf076d764}",
         "TypeName":"X509 Server Certificate"
      },
      {
         "AbsoluteGUID":"{1f57776d...} {da985a3f...} {74b2555a...}",
         "DN":"\\VED\\Policy\\Certificates\\www.company.com",
         "GUID":"{74b2555a-98a6-47fc-a091-af369960f410}",
         "Name":"www.company.com",
         "Parent":"\\VED\\Policy\\Certificates",
         "Revision":635349431438238650,
         "AttributeList":"{a80714f0-565c-4bc2-9026-787cf076d764}",
         "TypeName":"X509 Certificate"
      }
   ],
   "Result":0
}