POST Config/FindPolicy

Returns the policy values that have been set for the specified object, class, and attribute.

Requirements

  • Permissions:  The caller must have Read permission to the requested object.
  • Token scope:  Configuration

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

ObjectDN

The Distinguished Name (DN) of the policy object.

Class

The name of the object’s class.

AttributeName

The attribute name for which values are to be returned. For more information, see How to find class names and attributes.

Returns

Response description

Name

Description

HTTP 200

For valid requests, this call returns a HTTP 200 message and the following data in the message body:

  • Error: Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.
  • Locked: When set to true, indicates that the value is unchangable.

  • PolicyDN: When set to true, indicates that the value is unchangable.

  • Result: The result code that indicates the reason for success or failure. For more information, see Config result codes.
  • Values:A array of values for the class/attribute name.

HTTP 400

For invalid requests, this call returns HTTP 400 Bad Request and the following data in the message body:

  • error: The reason for the error.
  • error_description: If available, additional information about how to retry the request.

Example Search for policy values

Request

POST https://tpp.venafi.example/vedsdk/Config/FindPolicy
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\TestCert",
   "Class":"X509 Certificate",
   "AttributeName":"ManagementType"
}

Response

HTTP/1.1 200 OK
{
   "Locked":true,
   "PolicyDN":"\\VED\\Policy\\TestCert",
   "Result":1,
   "Values":[
	"Policy description"
   ]
}