POST Metadata/ReadEffectiveValues
Returns the effective value of a Custom Field for a particular object.
Requirements
- Permissions: The caller must have Read 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
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. |
ItemGuid |
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}. To get the GUIDs for a DN, use POST Metadata/GetItemGuids. |
Returns
Name |
Description |
---|---|
Locked |
The status of the data:
|
PolicyDn | The DN of the policy from which the value was inherited, or would have been inherited had it not been overridden. |
Result | The reason for success or failure. For more information, see Metadata Result Codes. |
Values | An array of values applicable to the Custom Field type. |
Example: Show certificate values
Request
POST https://tpp.venafi.example/vedsdk/Metadata/ReadEffectiveValues Authorization:Bearer 4MyGeneratedBearerTknz== { "DN": "\\VED\\Policy\\Certificates\\www.company.com", "ItemGuid": "{a80714f0-565c-4bc2-9026-787cf076d764}", }
Response
HTTP/1.1 200 OK { "Locked":true, "PolicyDn":"\\VED\\Policy\\Certificates", "Result":0 "Values":["XYZ789"] }