POST Config/RemovePolicyValue

Removes a specific value instance of a policy attribute for an object class. Applies only to folder or other folder objects that support policy settings.

Requirements

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

AttributeName

The name of the attribute to update.

Class

A class name. For example Device or CAPI Trust Store. For more information, see How to find class names and attributes.

Value

A corresponding class attribute. 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 a HTTP 400 BadRequest 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: Clear a policy attribute value

Request

POST https://tpp.venafi.example/vedsdk/Config/RemovePolicyValue
Authorization:Bearer 4MyGeneratedBearerTknz==
{
   "ObjectDN":"\\VED\\Policy\\TestPolicy",
   "Class":"X509Certificate",
   "AttributeName":"City",
   "Value":"Sandy"
}

Response

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