POST Config/IsValid

Verifies the validity of a Distinguished Name (DN) or a GUID. You can call this method to test whether a proposed new object name is available for use.

Requirements

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

Specify at least one parameter

Input parameters

Name

Description

ObjectDN

(Optional) The Object Distinguished Name (DN).

ObjectGUID

(Optional) The unique object GUID enclosed in curly braces. For example {112adf57-07b7-41fe-9d3a-5f342e421c68}. To get the GUID, call POST Config/Find.

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.
  • Object:The object referenced by the Distinguished Name (DN) or GUID:
    • AbsoluteGUID: The Universally Unique Identifiers for a ConfigKey and each parental ConfigKey within the hierarchical storage system.
    • DN: The object DN.
    • Error : Appears only when the operation cannot supply the necessary data. Provides only a description and Result. No other data.
    • GUID: The object GUID.
    • Id: The Trust Protection Platform object identifier.
    • Name: The object name.
    • Parent: The full parent name.
    • Revision: The revision number of the last object change.
    • TypeName: The object class name.
  • 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: Determine whether a DN is valid

Request

POST https://tpp.venafi.example/vedsdk/Config/IsValid
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Engines\\Engine_1"
}

Response

HTTP/1.1 200 OK
{
   "Object":{
      "AbsoluteGUID":"{1aed731d-3db6-4f61-b186-9c05ea486df8} 
         {981c0b88-bbf7-4a87-b5ee-b328dce41b75} 
         {112adf57-07b7-41fe-9d3a-5f342e421c68}",
      "DN":"\\VED\\Engines\\Engine_1",
      "GUID":"{112adf57-07b7-41fe-9d3a-5f342e421c68}",
      "Id":297,
      "Name":"Engine_1",
      "Parent":"\\VED\\Engines",
      "Revision":1640,
      "TypeName":"VenafiPlatform"
   },
   "Result":1
}