POST Config/ReadDn

Returns values of an object Distinguished Name (DN) based. You can only use a DistinguishedName attribute from the schema. The response does not include policy-assigned values.

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

A value, from the BaseSchema.xml. Use a value that is:

  • Declared in the XML with a Syntax of DistinguishedName.

    Attribute is a 'DistinguisedName' from the schema

  • Valid for the ObjectDN. To confirm that this attribute applies to the object, use the child schemes or Support tab.

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. For CacheEntryNotFound errors, check the XML schema for the object or use the UI Support tab and confirm that the attribute is valid for the DN.
  • 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: What consumes my certificate?

Request

POST https://tpp.venafi.example/vedsdk/Config/ReadDn
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\folder\\Certificate",
   "AttributeName":"Consumers"
}

Response

HTTP/1.1 200 OK
{
   "Result":1,
   "Values":[
      "\\VED\\Policy\\folder\\Device2\\Basic1",
      "\\VED\\Policy\\folder\\Device2\\Basic3"
   ]
}