POST Config/Read

Returns the values for every object attribute, excluding values assigned by policy.

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 object.
AttributeName	An attribute name that is an aspect of the ObjectDN. For example, if ObjectDN is a certificate, specify an X509 Certificate Object. 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. Result: The result code that indicates the reason for success or failure. For more information, see Config result codes. Values: An array of values read from the attributes of the object.
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: Read a DN attribute value

Request

POST https://tpp.venafi.example/vedsdk/Config/Read
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Discovery\\PrivateNetworks",
   "AttributeName":"AddressRange"
}

Response

HTTP/1.1 200 OK
{
   "Result": 1,
   "Values":[
      "172.16.1.1-172.16.1.254:443,7002",
      "172.17.1.1-172.17.1.254:443,7002",
      "172.18.1.1-172.18.1.254:443,7002"
   ]
}