POST Config/ClearAttribute

Removes all value instances of an attribute from an object. The caller must have Write permission to the requested object.

Requirements

  • Permissions:  The caller must have Write permission to the requested object.
  • Token scope:  Configuration:Manage

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 containing the attribute.

AttributeName

The name of the attribute that requires clearing. 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.

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: Set a DN attribute value to null

Request

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

Response

HTTP/1.1 200 OK
{
   "Result":1
}