POST Config/EnumeratePolicies

Returns all policies that apply to every item in the specified folder object.

Requirements

  • Permissions:  In order to properly enumerate the policy, 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 policy object or folder name that contains policy values.

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.

  • Policies: An array of policy objects that are associated with the Object DN.

    • AttributeName: The policy attribute name.
    • GUID: The GUID that identifies the policy.
    • Property: The status of the policy. 1 = A locked policy. If there is no property value, this field is omitted.
    • TypeName: The class name of the policy item.
    • ValueList: The list of values stored as the policy item.
  • Result: The result code that indicates the reason for success or failure. For more information, see Config result codes.

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: Show policy information for a DN

Request

POST https://tpp.venafi.example/vedsdk/Config/EnumeratePolicies
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\CertPolicy\\"
}

Response

HTTP/1.1 200 OK
{
   "Policies":[
      {
         "AttributeName":"Certificate Download: PBES2 Algorithm",
         "GUID":"{be3c5bdb-17de-4d4d-91e1-f4d519bb5e0a}",
         "TypeName":"X509 Certificate",
         "ValueList":[
            "MD5/DES"
         ]
      },
      {
         "AttributeName":"Enforce Unique Subject",
         "GUID":"{be3c5bdb-17de-4d4d-91e1-f4d519bb5e0a}",
         "TypeName":"X509 Certificate",
         "ValueList":[
            "0"
         ]
      },
      {
         "AttributeName":"Management Type",
         "GUID":"{be3c5bdb-17de-4d4d-91e1-f4d519bb5e0a}",
         "Property":1,
         "TypeName":"X509 Certificate",
         "ValueList":[
            "Provisioning"
         ]
      },
      {
         "AttributeName":"PKCS10 Hash Algorithm",
         "GUID":"{be3c5bdb-17de-4d4d-91e1-f4d519bb5e0a}",
         "TypeName":"X509 Certificate",
         "ValueList":[
            "Sha256"
         ]
      },
      {
         "AttributeName":"Prohibit Wildcard",
         "GUID":"{be3c5bdb-17de-4d4d-91e1-f4d519bb5e0a}",
         "TypeName":"X509 Certificate",
         "ValueList":[
            "0"
         ]
      }
   ],
   "Result":1
}