ジャンプ先

• リクエスト
• レスポンス
• 例

構成プロパティを削除する。

delete

/policy/config/property/v1

永続ストアに格納されている構成プロパティを削除します。

リクエスト

問合せパラメータ

• propertyName(required): string
  削除するプロパティ名。可能な場合は、入力と完全に一致する名前のプロパティが削除されます。

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされるメディア・タイプ

• application/xml
• application/json

200レスポンス

成功。削除するプロパティが存在するかどうかにかかわらず、200レスポンスが返されます。このAPIレスポンスには、空のプロパティ配列が含まれています。

本文()

ルート・スキーマ: ConfigAPIResponse

型: object

ソースの表示

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

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

401レスポンス

未認可

406レスポンス

不正なデータ

本文()

ルート・スキーマ: ConfigAPIResponse

型: object

ソースの表示

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

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

先頭に戻る

例

次の例は、永続ストアに格納されている構成プロパティを削除するサンプルのリクエストとレスポンスを示します。

JSON形式で構成プロパティを削除するcURLコマンド

curl --location --request DELETE '<PolicyUrl>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

JSON形式のサンプル・レスポンス

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

XML形式で構成プロパティを削除するcURLコマンド

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>)>'

XML形式のサンプル・レスポンス

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

先頭に戻る