POST Metadata/FindItem

Returns the Custom Field settings based on the UI label.

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

Name

The label name of a Custom Field. To get the Name, use POST Metadata/GetItems or look in the UI. For more information, see Viewing custom fields.

Returns

Response description

Name

Description

ItemGuid

The globally unique identifier of the Custom Field that contains the requested Name. 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: Find the label name for a Custom Field

Request

POST https://tpp.venafi.example/vedsdk/Metadata/FindItem
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "Name": "Cost Center"
}

Response

HTTP/1.1 200 OK
{
   "ItemGuid":"{a80714f0-565c-4bc2-9026-787cf076d764",
   "Locked":false,
   "Result":0
}