Jump to

• Request
• Response
• Examples

Creates or updates configuration properties.

put

/policy/config/property/v1

Creates or updates configuration properties and returns these properties.

Request

There are no request parameters for this operation.

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: array

The object is used to create or update configuration properties.

Show Source

• Array of: object NameValPair
  Name-value pair which can be used generically.

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

Nested Schema : NameValPair

Type: object

Name-value pair which can be used generically.

Show Source

• name(required): string
  Property name.
• value(required): string
  Property Value 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."
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: array

The object is used to create or update configuration properties.

Show Source

• Array of: object NameValPair
  Name-value pair which can be used generically.

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

Nested Schema : NameValPair

Type: object

Name-value pair which can be used generically.

Show Source

• name(required): string
  Property name.
• value(required): string
  Property Value 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."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success

Body ()

Root Schema : ConfigPropertiesResponse

Type: array

Contains configuration properties returned from API.

Show Source

• Array of: object NameValSource
  Name-value and source of the property.

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

Nested Schema : NameValSource

Type: object

Name-value and source of the property.

Show Source

• name(required): string
  Property name.
• source(required): string
  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).
• value(required): string
  Property value 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 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 creating or updating the configuration properties.

cURL Command to Create or Update Configuration Properties in JSON Format

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}"
    }
]'

Sample Response in JSON Format

[
    {
        "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"
    }
]

cURL Command to Create or Update Configuration Properties in XML Format

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

Sample Response in XML Format

<?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>

Back to Top