返されたすべてのプロパティが入力で指定されたプロパティ名を含むように構成プロパティを取得する。
get
/config/property/v1
返されたすべてのプロパティが入力で指定されたプロパティ名を含むように構成プロパティを取得する。入力と一致しない場合、空のプロパティ配列が出力に存在します。
リクエスト
問合せパラメータ
- locale: string
特定のロケールでプロパティの値が必要な場合は、このオプション・パラメータを入力に指定できます。サービス実装でそのロケールのそのプロパティに対して値が定義されている場合は、その値が返されます。ロケールが指定されていないか、ロケール固有の値が入力プロパティ値に使用できない場合は、デフォルト・ロケール(en_US)のプロパティ値が入力に返されます。
- propertyName(required): string
構成プロパティを検索する名前。入力名を含むすべてのプロパティがレスポンスで返されます。
この操作にはリクエスト本文はありません。
先頭に戻るレスポンス
サポートされているメディア・タイプ
- application/xml
- application/json
200レスポンス
成功。
ルート・スキーマ: ConfigPropertiesResponse
型:
array
APIから返された構成プロパティが含まれます。
ソースの表示
- 配列: object NameValSource
プロパティの名前、値およびソース。
ネストされたスキーマ: NameValSource
型:
object
プロパティの名前、値およびソース。
ソースの表示
-
name(required): string
プロパティ名。
-
source(required): string
プロパティのロード元の場所。これは、ファイル(サービス実装の製品ファイル)、環境(サービスが実行されている場所)またはデータベース(サービスで使用される永続ストア)のいずれかです。
-
value(required): string
プロパティ値の文字列。
406レスポンス
不正なデータ。
例
次の例は、返されるすべてのプロパティに入力で指定されたプロパティ名が含まれる構成プロパティを取得するサンプルのリクエストとレスポンスを示します。
JSON形式で構成プロパティを取得するcURLコマンド
curl --location --request GET '<OAAService>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
JSON形式のサンプル・レスポンス
[ { "name": "bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress", "value": "security@example.com", "source": "database" } ]
XML形式で構成プロパティを取得するcURLコマンド
curl --location --request GET '<OAAService>/policy/config/property/v1?propertyName=bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress' \ --header 'Accept: application/xml' \ --header 'Content-Type: application/xml' \ --header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'
XML形式のサンプル・レスポンス
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <ConfigPropertiesResponse> <NameValSource> <name>bharosa.uio.default.challenge.type.enum.ChallengeEmail.fromAddress</name> <value>security@example.com</value> <source>database</source> </NameValSource> </ConfigPropertiesResponse>