Jump to

• Request
• Response
• Examples

Deletes configuration property.

delete

/policy/config/property/v1

Deletes the configuration property stored in the persistent store.

Request

Query Parameters

• propertyName(required): string
  Property name to delete. Property with name that is an exact match with the input will be deleted if possible.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success. Whether the property to be deleted exists or not, a 200 response is returned. This API response contains empty array of properties.

Body ()

Root Schema : ConfigAPIResponse

Type: object

Show Source

• responseCode(required): string
• responseMessage(required): string

{
    "type":"object",
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

406 Response

Incorrect Data

Body ()

Root Schema : ConfigAPIResponse

Type: object

Show Source

• responseCode(required): string
• responseMessage(required): string

{
    "type":"object",
    "required":[
        "responseCode",
        "responseMessage"
    ],
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following example shows a sample request and response for deleting the configuration property stored in the persistent store.

cURL Command to Delete the Configuration Property in JSON Format

curl --location --request DELETE '<PolicyUrl>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate' \
--header 'Authorization: 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 '<PolicyUrl>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: 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