Jump to

• Request
• Response
• Examples

Gets configuration properties.

get

/policy/config/property/v1

Gets configuration properties whose name contains the input property name. If there is no match, an empty property array will be returned.

Request

Query Parameters

• locale: string
  This optional parameter can be provided, if value of the property is desired in certain locale. If service implementation has value defined for that property in that locale then that value will be returned. If the locale is not provided or if locale specific value is not available for input property value, then property value in default locale (en_US) will be retuned.
• propertyName(required): string
  Property name to search. All properties that contain the input name are returned in the response.

There's no request body for this operation.

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 retrieving configuration properties.

cURL Command to Retrieve Configuration Property in JSON Format

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

Sample Response in JSON Format

[
    {
        "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress",
        "value": "[e-mail]",
        "source": "database"
    }
]

cURL Command to Retrieve Configuration Property in XML Format

curl --location --request GET '<PolicyUrl>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress' \
--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"?>
 <ConfigPropertiesResponse>
      <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress</name>
         <value>[e-mail]</value>
         <source>database</source>
  </ConfigPropertiesResponse>

Back to Top