ジャンプ先

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

構成プロパティを作成または更新する。

put

/policy/config/property/v1

構成プロパティを作成または更新し、これらのプロパティを返します。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ : schema

型: array

オブジェクトは、構成プロパティを作成または更新するために使用されます。

ソースの表示

• 配列: object NameValPair
  一般的に使用できる名前と値のペア。

{
    "description":"The object is used to create or update configuration properties.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValPair"
    }
}

ネストされたスキーマ: NameValPair

型: object

一般的に使用できる名前と値のペア。

ソースの表示

• name(required): string
  プロパティ名。
• value(required): string
  プロパティ値の文字列。

{
    "type":"object",
    "description":"Name-value pair which can be used generically.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property Value String."
        }
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ : schema

型: array

オブジェクトは、構成プロパティを作成または更新するために使用されます。

ソースの表示

• 配列: object NameValPair
  一般的に使用できる名前と値のペア。

{
    "description":"The object is used to create or update configuration properties.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValPair"
    }
}

ネストされたスキーマ: NameValPair

型: object

一般的に使用できる名前と値のペア。

ソースの表示

• name(required): string
  プロパティ名。
• value(required): string
  プロパティ値の文字列。

{
    "type":"object",
    "description":"Name-value pair which can be used generically.",
    "required":[
        "name",
        "value"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property Value String."
        }
    }
}

先頭に戻る

レスポンス

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

• application/xml
• application/json

200レスポンス

成功

本文()

ルート・スキーマ: ConfigPropertiesResponse

型: array

APIから返された構成プロパティが含まれます。

ソースの表示

• 配列: object NameValSource
  プロパティの名前、値およびソース。

{
    "description":"Contains configuration properties returned from API.",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/NameValSource"
    }
}

ネストされたスキーマ: NameValSource

型: object

プロパティの名前、値およびソース。

ソースの表示

• name(required): string
  プロパティ名。
• source(required): string
  プロパティのロード元となるソース。これは、ファイル(サービス実装の製品ファイル)、環境(サービスが実行されている場所)またはデータベース(サービスで使用される永続ストア)のいずれかです。
• value(required): string
  プロパティ値の文字列。

{
    "type":"object",
    "description":"Name-value and source of the property.",
    "required":[
        "name",
        "value",
        "source"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Property name."
        },
        "value":{
            "type":"string",
            "description":"Property value string."
        },
        "source":{
            "type":"string",
            "description":"Source where the property is loaded from. This can be file(product files of service implementation), environment(where service is running)  or database(persistent store used by the service)."
        }
    }
}

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 PUT '<PolicyUrl>/policy/config/property/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '[
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage",
        "value": "Send OTP to {0}"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage",
        "value": "Please select one of following addresses to receive OTP."
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText",
        "value": "Enter OTP sent to {0}."
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject",
        "value": "One Time PIN: Example Company"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate",
        "value": "Please use following one time pin to login to the protected resource:"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate",
        "value": "Time of Access:"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate",
        "value": "Resource URL Access:"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress",
        "value": "[e-mail]"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName",
        "value": "Example Company"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName",
        "value": "OAA"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage",
        "value": "Send OTP to phone {0}"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage",
        "value": "Please select one of following numbers to receive OTP."
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText",
        "value": "Enter OTP sent to {0}."
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject",
        "value": "One Time PIN: Example Company"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate",
        "value": "Please use following one time pin to login to the protected resource:"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate",
        "value": "Time of Access:"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate",
        "value": "IP Address:"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate",
        "value": "Resource URL Access:"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress",
        "value": "[e-mail]"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName",
        "value": "Example Company"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName",
        "value": "OAA"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage",
        "value": "Enter OTP from registered phone"
    },
     {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage",
        "value": "Please select one of following channels"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText",
        "value": "Enter OTP from device {1}"
    }
]'

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

[
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage",
        "value": "Send OTP to {0}",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage",
        "value": "Please select one of following addresses to receive OTP.",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText",
        "value": "Enter OTP sent to {0}.",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject",
        "value": "One Time PIN: Example Company",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate",
        "value": "Please use following one time pin to login to the protected resource:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate",
        "value": "Time of Access:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate",
        "value": "Resource URL Access:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress",
        "value": "[e-mail]",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName",
        "value": "Example Company",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName",
        "value": "OAA",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage",
        "value": "Send OTP to phone {0}",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage",
        "value": "Please select one of following numbers to receive OTP.",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText",
        "value": "Enter OTP sent to {0}.",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject",
        "value": "One Time PIN: Example Company",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate",
        "value": "Please use following one time pin to login to the protected resource:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate",
        "value": "Time of Access:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate",
        "value": "IP Address:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate",
        "value": "Resource URL Access:",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress",
        "value": "[e-mail]",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName",
        "value": "Example Company",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName",
        "value": "OAA",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage",
        "value": "Enter OTP from registered phone",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage",
        "value": "Please select one of following channels",
        "source": "database"
    },
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText",
        "value": "Enter OTP from device {1}",
        "source": "database"
    }
]

XML形式で構成プロパティを作成または更新するcURLコマンド

curl --location --request PUT '<PolicyUrl>/policy/config/property/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <ConfigPropertiesRequest>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage</name>
         <value>Send OTP to {0}</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage</name>
         <value>Please select one of following addresses to receive OTP.</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText</name>
         <value>Enter OTP sent to {0}.</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject</name>
         <value>One Time PIN: Example Company</value>
          <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate</name>
         <value>Please use following one time pin to login to the protected resource:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate</name>
         <value>Time of Access:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate</name>
         <value>Resource URL Access:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress</name>
         <value>[e-mail]</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName</name>
         <value>Example Company</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName</name>
         <value>OAA</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage</name>
         <value>Send OTP to phone {0}</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage</name>
         <value>Please select one of following numbers to receive OTP.</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText</name>
         <value>Enter OTP sent to {0}.</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject</name>
         <value>One Time PIN: Example Company</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate</name>
         <value>Please use following one time pin to login to the protected resource:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate</name>
         <value>Time of Access:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate</name>
         <value>IP Address:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate</name>
         <value>Resource URL Access:</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress</name>
         <value>[e-mail]</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName</name>
         <value>Example Company</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName</name>
         <value>OAA</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage</name>
         <value>Enter OTP from registered phone</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage</name>
         <value>Please select one of following channels</value>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText</name>
         <value>Enter OTP from device {1}</value>
     </ConfigPropertiesRequest>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ConfigPropertiesResponse>
        <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptmessage</name>
         <value>Send OTP to {0}</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.promptselectmessage</name>
         <value>Please select one of following addresses to receive OTP.</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.challengeText</name>
         <value>Enter OTP sent to {0}.</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgSubject</name>
         <value>One Time PIN: Example Company</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgPinTemplate</name>
         <value>Please use following one time pin to login to the protected resource:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate</name>
         <value>Time of Access:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.msgTimeTemplate</name>
         <value>Resource URL Access:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress</name>
         <value>[e-mail]</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromName</name>
         <value>Example Company</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.appName</name>
         <value>OAA</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptmessage</name>
         <value>Send OTP to phone {0}</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.promptselectmessage</name>
         <value>Please select one of following numbers to receive OTP.</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.challengeText</name>
         <value>Enter OTP sent to {0}.</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgSubject</name>
         <value>One Time PIN: Example Company</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgPinTemplate</name>
         <value>Please use following one time pin to login to the protected resource:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgTimeTemplate</name>
         <value>Time of Access:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgIPTemplate</name>
         <value>IP Address:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.msgResourceURLTemplate</name>
         <value>Resource URL Access:</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromAddress</name>
         <value>[e-mail]</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.fromName</name>
         <value>Example Company</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeSMS.appName</name>
         <value>OAA</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeTOTP.promptmessage</name>
         <value>Enter OTP from registered phone</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.promptselectmessage</name>
         <value>Please select one of following channels</value>
         <source>database</source>
         <name>bharosa.uio.default.challenge.type.enum.ChallengeOMATOTP.challengeText</name>
         <value>Enter OTP from device {1}</value>
         <source>database</source>
   </ConfigPropertiesResponse>

先頭に戻る