1. OAA Runtime API
  2. Tasks
  3. ConfigProperty

Deletes configuration property that is provided in the input.

delete

/config/property/v1

Whether property to be deleted exists or not a 200 response is returned. If no config property is provided in the input then this is function does not change anything in config properties, and a 200 response is returned. Only properties that are stored in the persistent store can be deleted. Properties that are sourced from product files and product environment cannot be deleted using this API. This API returns API Response. API response contains empty array of properties in all cases.

Request

Query Parameters

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Success
Body ()
Root Schema : ConfigAPIResponse
Type: object
Show Source

406 Response

Incorrect Data
Body ()
Root Schema : ConfigAPIResponse
Type: object
Show Source
Back to Top

Examples

The following example shows a sample request and response for deleting the configuration property specified in the input.

cURL Command to Delete the Configuration Property in JSON Format

curl --location --request DELETE '<OAAService>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Basic <Base64Encoded(<username>:<password>)>'

Sample Response in JSON Format

{
    "responseCode": "200",
    "responseMessage": "Configuration property successfully deleted."
}

cURL Command to Delete the Configuration Property in XML Format

curl --location --request DELETE '<OAAService>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Basic <Base64Encoded(<username>:<password>)>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ConfigAPIResponse>
    <responseCode>200</responseCode>
    <responseMessage>Configuration property successfully deleted.</responseMessage>
</ConfigAPIResponse>
Back to Top