POST Config/IdInfo

Important! This page is no longer supported or being updated. It is left here for reference purposes. We encourage you to find corresponding information in our new API Reference documentation.

Retrieves details about a Config object.

Requirements

  • Permissions:  The caller must have View permission to the requested object.
  • Token scope:  Any valid scope, such as Agent, Certificate, or SSH

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

ObjectID

The Trust Protection Platform object identifier. To get the ObjectID, call POST Config/IsValid.

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:

  • ClassName: The object class.
  • Error : Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.
  • GUID: The unique object GUID enclosed in curly braces. For example {112adf57-07b7-41fe-9d3a-5f342e421c68}.
  • HierarchicalGUID: The object hierarchical GUID.
  • Result: The result code that indicates the reason for success or failure. For more information, see Config result codes.
  • Revision: Revision.

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: Find information about a DN

POST https://tpp.venafi.example/vedsdk/Config/IdInfo
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectID":"10"
}

Response

HTTP/1.1 200 OK
{
   "ClassName":"Engine Root",
   "GUID":"{749d1a44-ebd7-4b45-96c3-1ed91b3bf803}",
   "HierarchicalGUID":"{9c061779-5bb9-4038-9365-9a4fec43701e}\n
      {749d1a44-ebd7-4b45-96c3-1ed91b3bf803}",
   "ObjectDN":"\\VED\\Engines",
   "Result":1,
   "Revision":1450
}