Oracle Web Services Manager REST API

ConfigurationPropertyの取得

get

/v2/configuration

特定のドメイン・コンテキストのConfigurationPropertyをすべて取得します。ドメイン・コンテキストは、リクエストURLパス内のplatformおよびdomainの問合せパラメータによって定義されます。省略すると、現在のドメインが使用されます。レスポンス本文のプロパティの'source'フィールドは、プロパティ値がデフォルト(defaultという値)であるか、特定のドメイン・コンテキスト(/platform/domain)に設定されているかを示します。レスポンス内のConfigurationPropertyは、nameやcategoryなどの1つ以上の問合せパラメータによってさらにフィルタできます(例: ?name=myPropName&category=myPropCategory)

リクエスト

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

application/json

問合せパラメータ

category(optional): string

表示をリクエストするConfigurationPropertyのグループのカテゴリ

使用可能な値: [ "Agent", "BeanAccessor", "ConfigManager", "DigestLoginModule", "Identity", "IssuedToken", "KerberosLoginModule", "KeystoreConfig", "SAML2LoginModule", "SAMLLoginModule", "TokenIssuerTrust", "SecureConversation", "STSConfig", "SubjectProperties", "UsernameAssertionLoginModule", "WSSDigestLoginModule", "X509LoginModule" ]
domain(optional): string

ドメイン・コンテキストのドメイン名。省略すると、現在のドメインが使用されます。
name(optional): string

有効なエンタープライズ定義プロパティ名である必要がある、表示をリクエストするConfigurationPropertyの名前。
platform(optional): string

ドメイン・コンテキストのプラットフォーム。省略すると、現在のデフォルトのプラットフォームが使用されます。

先頭に戻る

レスポンス

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

application/json

200レスポンス

成功した操作

ルート・スキーマ: schema

タイプ: array

ソースの表示

配列: オブジェクト ConfigurationProperty

ConfigurationPropertyモデル・オブジェクト。

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ConfigurationProperty"
    }
}

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

タイプ: object

ConfigurationPropertyモデル・オブジェクト。

ソースの表示

category(optional): string

使用可能な値: [ "Agent", "BeanAccessor", "ConfigManager", "DigestLoginModule", "Identity", "IssuedToken", "KerberosLoginModule", "KeystoreConfig", "SAML2LoginModule", "SAMLLoginModule", "TokenIssuerTrust", "SecureConversation", "STSConfig", "SubjectProperties", "UsernameAssertionLoginModule", "WSSDigestLoginModule", "X509LoginModule" ]

構成プロパティのカテゴリ。デフォルトの構成プロパティが設定されている場合、このフィールドはシステムによって自動的に設定され、ユーザーはこのフィールドの値を変更できません。
name: string

システムによって事前定義された構成プロパティの名前。これは、カテゴリ内で一意です。プロパティの名前とその値は、システムによって事前に定義されており、ユーザーは、構成プロパティを追加することも削除することもできません。これらは、デフォルト値を上書きするか、上書きされた値をシステムの元のデフォルトに戻すことで、変更できます。

例: agent.clock.skew
source(optional): string

このフィールドは、システムによって自動的に設定されます。ユーザーは、プロパティ値の更新時にこのフィールドの値を変更しません。このプロパティにシステムのデフォルト値がある場合は'default'と表示され、それ以外の場合は、フィールドに、プロパティ値がリセットされるドメイン・コンテキストが表示されます。ドメイン・コンテキストは、/{platformName}/{domainName}で構成されます。
values: array values

デフォルト値がシステムによって指定され、PUTメソッドをコールすることで新しい値でオーバーライドできる、構成プロパティの値のリスト。

{
    "type":"object",
    "required":[
        "name",
        "values"
    ],
    "properties":{
        "name":{
            "type":"string",
            "example":"agent.clock.skew",
            "description":"Name of a system predefined configuration property or properties. It is unique within a category. Names of properties and their values are predefined by the system, users cannot add or remove configuration properties; they can modify them by either overwriting the default values or reverting overwritten values back to the system original default. "
        },
        "category":{
            "type":"string",
            "description":"Category of a configuration property. This field is set automatically by the system when default configuration properties are set users cannot modify the value of this field.",
            "enum":[
                "Agent",
                "BeanAccessor",
                "ConfigManager",
                "DigestLoginModule",
                "Identity",
                "IssuedToken",
                "KerberosLoginModule",
                "KeystoreConfig",
                "SAML2LoginModule",
                "SAMLLoginModule",
                "TokenIssuerTrust",
                "SecureConversation",
                "STSConfig",
                "SubjectProperties",
                "UsernameAssertionLoginModule",
                "WSSDigestLoginModule",
                "X509LoginModule"
            ]
        },
        "values":{
            "type":"array",
            "example":"['5000']",
            "description":"A list of values of a configuration property, default value is given by the system, one can override with new value by calling PUT method.",
            "items":{
                "type":"string"
            }
        },
        "source":{
            "type":"string",
            "description":"This feild is set automatically by the system. Users do not modify the value of this fieldduring updating a property value. If the property has the system default value then it shows as 'default' otherwise this field shows the domain context which property value is being reset. Domain context is composed of /{platformName}/{domainName}."
        }
    },
    "description":"ConfigurationProperty model object."
}

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

タイプ: array

デフォルト値がシステムによって指定され、PUTメソッドをコールすることで新しい値でオーバーライドできる、構成プロパティの値のリスト。

ソースの表示

配列: 文字列

{
    "type":"array",
    "example":"['5000']",
    "description":"A list of values of a configuration property, default value is given by the system, one can override with new value by calling PUT method.",
    "items":{
        "type":"string"
    }
}

例:

['5000']

400レスポンス

ユーザーのリクエストが正しくありません。入力データを修正して再試行してください。

ルート・スキーマ: ResponseStatus

タイプ: object

ResponseStatusモデル・オブジェクト。

ソースの表示

MESSAGE(optional): string

レスポンスが成功の場合は、その確認である、レスポンスの詳細メッセージで、それ以外の場合は根本的原因を示すエラー・メッセージ。

例: PolicySets [myPolicyset1, myPolicyset2] are successfully created.
STATUSCODE(optional): string

使用可能な値: [ "20001", "20002", "20003", "20004", "20005", "20011", "20012", "20013", "20014", "20021", "20023", "20024", "20032", "20033", "20034", "20035", "20042", "20043", "20044", "20051", "20052", "20053", "20054", "20055", "20061", "20062", "20063", "20064", "20065", "20071", "20072", "20073", "20074", "20075", "20081", "20082", "20083", "20084", "20085", "20091", "20092", "20093", "20094", "20095", "20101", "20102", "20103", "20104", "20105", "20111", "20112", "20113", "20114", "20115", "20121", "20122", "20123", "20124", "20125", "20131", "20132", "20133", "20134", "20135", "20141", "20142", "20143", "20144", "20145", "20151", "20152", "20153", "20154", "20155", "20161", "20162", "20163", "20164", "20165", "20171", "20172", "20173", "20174", "20175", "40001", "40002", "40003", "40004", "40011", "40012", "40013", "40014", "40021", "40023", "40024", "40032", "40033", "40042", "40043", "40044", "40051", "40052", "40053", "40054", "40061", "40062", "40063", "40064", "40071", "40072", "40073", "40074", "40081", "40082", "40083", "40084", "40091", "40092", "40093", "40094", "40101", "40102", "40103", "40104", "40111", "40112", "40113", "40114", "40121", "40122", "40123", "40124", "40131", "40132", "40133", "40134", "40141", "40142", "40143", "40144", "40151", "40152", "40153", "40154", "40161", "40162", "40163", "40164", "40171", "40172", "40173", "40174" ]

様々なAPIの操作についてのOWSM Rest APIステータス・コード。次のルールに基づいてテストを記述し、ステータス・コードを解析できます。ステータス・コードをプログラムで処理する場合は、oracle.wsm.resources.rest.RestMessageID.javaで定義された定数のOWSMソース・ファイルにアクセスできます。ステータス・コード・パターン: 左側から1つ目の数字は操作ステータス(2=成功、4=失敗)を示し、最後の数字は操作(1=POST、2=PUT、3=GET、4=DELETE、5=DELETE NONE)を示します。左側から2つ目、3つ目、4つ目の数字はOWSM Rest APIリソース・タイプ(000=PolicySet、001=PolicyReference、002=ConfigOverride、003=Configuration、004=Repository (未使用)、005=Trust、006=Issuer、007=TrustedKey、008=KeyIdentifier、009=RelyingParty、010=AttributeRule、011=Attribute、012=VirtualUser、013=RoleMapping、014=Mapping、015=NamedID、016=DiscoveryInfo、017=Proxy)に使用されます

例: 20001

{
    "type":"object",
    "properties":{
        "STATUSCODE":{
            "type":"string",
            "example":"20001",
            "description":"OWSM Rest API status code for operations on various APIs. One can write tests and parse the status code based on the rules below. If you plan to process the status code programmatically, you can access the OWSM source file for the constants defined at: oracle.wsm.resources.rest.RestMessageID.java. Status Code Pattern:first digit from left indicates the operation status, 2=successful, 4=failed last digit indicate operation 1=POST, 2=PUT, 3=GET, 4=DELETE, 5=DELETE NONE. second, third, fourth digits from left are used for OWSM Rest API Resource types: 000=PolicySet, 001=PolicyReference, 002=ConfigOverride, 003=Configuration, 004=Repository (not used yet),  005=Trust, 006=Issuer, 007=TrustedKey, 008=KeyIdentifier, 009=RelyingParty, 010=AttributeRule,  011=Attribute, 012=VirtualUser, 013=RoleMapping, 014=Mapping, 015=NamedID, 016=DiscoveryInfo, 017=Proxy",
            "enum":[
                "20001",
                "20002",
                "20003",
                "20004",
                "20005",
                "20011",
                "20012",
                "20013",
                "20014",
                "20021",
                "20023",
                "20024",
                "20032",
                "20033",
                "20034",
                "20035",
                "20042",
                "20043",
                "20044",
                "20051",
                "20052",
                "20053",
                "20054",
                "20055",
                "20061",
                "20062",
                "20063",
                "20064",
                "20065",
                "20071",
                "20072",
                "20073",
                "20074",
                "20075",
                "20081",
                "20082",
                "20083",
                "20084",
                "20085",
                "20091",
                "20092",
                "20093",
                "20094",
                "20095",
                "20101",
                "20102",
                "20103",
                "20104",
                "20105",
                "20111",
                "20112",
                "20113",
                "20114",
                "20115",
                "20121",
                "20122",
                "20123",
                "20124",
                "20125",
                "20131",
                "20132",
                "20133",
                "20134",
                "20135",
                "20141",
                "20142",
                "20143",
                "20144",
                "20145",
                "20151",
                "20152",
                "20153",
                "20154",
                "20155",
                "20161",
                "20162",
                "20163",
                "20164",
                "20165",
                "20171",
                "20172",
                "20173",
                "20174",
                "20175",
                "40001",
                "40002",
                "40003",
                "40004",
                "40011",
                "40012",
                "40013",
                "40014",
                "40021",
                "40023",
                "40024",
                "40032",
                "40033",
                "40042",
                "40043",
                "40044",
                "40051",
                "40052",
                "40053",
                "40054",
                "40061",
                "40062",
                "40063",
                "40064",
                "40071",
                "40072",
                "40073",
                "40074",
                "40081",
                "40082",
                "40083",
                "40084",
                "40091",
                "40092",
                "40093",
                "40094",
                "40101",
                "40102",
                "40103",
                "40104",
                "40111",
                "40112",
                "40113",
                "40114",
                "40121",
                "40122",
                "40123",
                "40124",
                "40131",
                "40132",
                "40133",
                "40134",
                "40141",
                "40142",
                "40143",
                "40144",
                "40151",
                "40152",
                "40153",
                "40154",
                "40161",
                "40162",
                "40163",
                "40164",
                "40171",
                "40172",
                "40173",
                "40174"
            ]
        },
        "MESSAGE":{
            "type":"string",
            "example":"PolicySets [myPolicyset1, myPolicyset2] are successfully created.",
            "description":"Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause."
        }
    },
    "description":"ResponseStatus model object."
}

500レスポンス

操作は予期しないエラーで失敗しました。

ルート・スキーマ: ResponseStatus

タイプ: object

ResponseStatusモデル・オブジェクト。

ソースの表示

MESSAGE(optional): string

レスポンスが成功の場合は、その確認である、レスポンスの詳細メッセージで、それ以外の場合は根本的原因を示すエラー・メッセージ。

例: PolicySets [myPolicyset1, myPolicyset2] are successfully created.
STATUSCODE(optional): string

使用可能な値: [ "20001", "20002", "20003", "20004", "20005", "20011", "20012", "20013", "20014", "20021", "20023", "20024", "20032", "20033", "20034", "20035", "20042", "20043", "20044", "20051", "20052", "20053", "20054", "20055", "20061", "20062", "20063", "20064", "20065", "20071", "20072", "20073", "20074", "20075", "20081", "20082", "20083", "20084", "20085", "20091", "20092", "20093", "20094", "20095", "20101", "20102", "20103", "20104", "20105", "20111", "20112", "20113", "20114", "20115", "20121", "20122", "20123", "20124", "20125", "20131", "20132", "20133", "20134", "20135", "20141", "20142", "20143", "20144", "20145", "20151", "20152", "20153", "20154", "20155", "20161", "20162", "20163", "20164", "20165", "20171", "20172", "20173", "20174", "20175", "40001", "40002", "40003", "40004", "40011", "40012", "40013", "40014", "40021", "40023", "40024", "40032", "40033", "40042", "40043", "40044", "40051", "40052", "40053", "40054", "40061", "40062", "40063", "40064", "40071", "40072", "40073", "40074", "40081", "40082", "40083", "40084", "40091", "40092", "40093", "40094", "40101", "40102", "40103", "40104", "40111", "40112", "40113", "40114", "40121", "40122", "40123", "40124", "40131", "40132", "40133", "40134", "40141", "40142", "40143", "40144", "40151", "40152", "40153", "40154", "40161", "40162", "40163", "40164", "40171", "40172", "40173", "40174" ]

様々なAPIの操作についてのOWSM Rest APIステータス・コード。次のルールに基づいてテストを記述し、ステータス・コードを解析できます。ステータス・コードをプログラムで処理する場合は、oracle.wsm.resources.rest.RestMessageID.javaで定義された定数のOWSMソース・ファイルにアクセスできます。ステータス・コード・パターン: 左側から1つ目の数字は操作ステータス(2=成功、4=失敗)を示し、最後の数字は操作(1=POST、2=PUT、3=GET、4=DELETE、5=DELETE NONE)を示します。左側から2つ目、3つ目、4つ目の数字はOWSM Rest APIリソース・タイプ(000=PolicySet、001=PolicyReference、002=ConfigOverride、003=Configuration、004=Repository (未使用)、005=Trust、006=Issuer、007=TrustedKey、008=KeyIdentifier、009=RelyingParty、010=AttributeRule、011=Attribute、012=VirtualUser、013=RoleMapping、014=Mapping、015=NamedID、016=DiscoveryInfo、017=Proxy)に使用されます

例: 20001

{
    "type":"object",
    "properties":{
        "STATUSCODE":{
            "type":"string",
            "example":"20001",
            "description":"OWSM Rest API status code for operations on various APIs. One can write tests and parse the status code based on the rules below. If you plan to process the status code programmatically, you can access the OWSM source file for the constants defined at: oracle.wsm.resources.rest.RestMessageID.java. Status Code Pattern:first digit from left indicates the operation status, 2=successful, 4=failed last digit indicate operation 1=POST, 2=PUT, 3=GET, 4=DELETE, 5=DELETE NONE. second, third, fourth digits from left are used for OWSM Rest API Resource types: 000=PolicySet, 001=PolicyReference, 002=ConfigOverride, 003=Configuration, 004=Repository (not used yet),  005=Trust, 006=Issuer, 007=TrustedKey, 008=KeyIdentifier, 009=RelyingParty, 010=AttributeRule,  011=Attribute, 012=VirtualUser, 013=RoleMapping, 014=Mapping, 015=NamedID, 016=DiscoveryInfo, 017=Proxy",
            "enum":[
                "20001",
                "20002",
                "20003",
                "20004",
                "20005",
                "20011",
                "20012",
                "20013",
                "20014",
                "20021",
                "20023",
                "20024",
                "20032",
                "20033",
                "20034",
                "20035",
                "20042",
                "20043",
                "20044",
                "20051",
                "20052",
                "20053",
                "20054",
                "20055",
                "20061",
                "20062",
                "20063",
                "20064",
                "20065",
                "20071",
                "20072",
                "20073",
                "20074",
                "20075",
                "20081",
                "20082",
                "20083",
                "20084",
                "20085",
                "20091",
                "20092",
                "20093",
                "20094",
                "20095",
                "20101",
                "20102",
                "20103",
                "20104",
                "20105",
                "20111",
                "20112",
                "20113",
                "20114",
                "20115",
                "20121",
                "20122",
                "20123",
                "20124",
                "20125",
                "20131",
                "20132",
                "20133",
                "20134",
                "20135",
                "20141",
                "20142",
                "20143",
                "20144",
                "20145",
                "20151",
                "20152",
                "20153",
                "20154",
                "20155",
                "20161",
                "20162",
                "20163",
                "20164",
                "20165",
                "20171",
                "20172",
                "20173",
                "20174",
                "20175",
                "40001",
                "40002",
                "40003",
                "40004",
                "40011",
                "40012",
                "40013",
                "40014",
                "40021",
                "40023",
                "40024",
                "40032",
                "40033",
                "40042",
                "40043",
                "40044",
                "40051",
                "40052",
                "40053",
                "40054",
                "40061",
                "40062",
                "40063",
                "40064",
                "40071",
                "40072",
                "40073",
                "40074",
                "40081",
                "40082",
                "40083",
                "40084",
                "40091",
                "40092",
                "40093",
                "40094",
                "40101",
                "40102",
                "40103",
                "40104",
                "40111",
                "40112",
                "40113",
                "40114",
                "40121",
                "40122",
                "40123",
                "40124",
                "40131",
                "40132",
                "40133",
                "40134",
                "40141",
                "40142",
                "40143",
                "40144",
                "40151",
                "40152",
                "40153",
                "40154",
                "40161",
                "40162",
                "40163",
                "40164",
                "40171",
                "40172",
                "40173",
                "40174"
            ]
        },
        "MESSAGE":{
            "type":"string",
            "example":"PolicySets [myPolicyset1, myPolicyset2] are successfully created.",
            "description":"Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause."
        }
    },
    "description":"ResponseStatus model object."
}

先頭に戻る