POST Config/ReadAll

Returns the values for all attributes of an object, excluding values assigned by policy.

Requirements

  • Permissions:  The caller must have 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.

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.
  • NameValues: The Name/Values pairs containing the attributes of the object.
  • 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 all DN attribute values

Request

POST https://tpp.venafi.example/vedsdk/Config/ReadAll
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\folder\\Device2\\Basic3"
}

Response

HTTP/1.1 200 OK
{
   "NameValues":[
      {
         "Name":"Allow Private Key Reuse",
         "Values":[
            "0"
         ]
      },
      {
         "Name":"Created By",
         "Values":[
            "Web SDK"
         ]
      },
      {
         "Name":"Disable Automatic Renewal",
         "Values":[
            "0"
         ]
      },
      {
         "Name":"Disable Password Complexity",
         "Values":[
            "0"
         ]
      },
      {
         "Name":"Driver Name",
         "Values":[
            "appx509certificate"
         ]
      },
      {
         "Name":"Generate Keypair On Application",
         "Values":[
            "0"
         ]
      },
      {
         "Name":"Management Type",
         "Values":[
            "Monitoring"
         ]
      },
      {
         "Name":"Manual Csr",
         "Values":[
            "0"
         ]
      },
      {
         "Name":"Validity Period",
         "Values":[
            "365"
         ]
      },
      {
         "Name":"Want Renewal",
         "Values":[
            "0"
         ]
      }
   ],
   "Result":1
}