REST API for Oracle Web Services Manager

Get ConfigurationProperty(s)

get

/v2/configuration

Get all ConfigurationProperty of a specific domain context. A domain context is defined by platform and domain query parameters in the request URL path. When it is omitted, the current domain is assumed. The 'source' field of a property in the response body indicates if the values of the property is default (with default being the value) or has been set for a specific domain context (/platform/domain). ConfigurationProperty in the response can be further filtered by one or more query parameters like name and category, for example ?name=myPropName&category=myPropCategory

Request

Supported Media Types

application/json

Query Parameters

category: string

The category of a group of ConfigurationProperty you request to view

Allowed Values: [ "Agent", "BeanAccessor", "ConfigManager", "DigestLoginModule", "Identity", "IssuedToken", "KerberosLoginModule", "KeystoreConfig", "SAML2LoginModule", "SAMLLoginModule", "TokenIssuerTrust", "SecureConversation", "STSConfig", "SubjectProperties", "UsernameAssertionLoginModule", "WSSDigestLoginModule", "X509LoginModule" ]
domain: string

The domain name of a domain context. If it is omitted, the current domain is assumed.
name: string

The name of those ConfigurationProperty you request to view, it must be a valid enterprise defined propty name.
platform: string

The platform of a domain context. If it is omitted, the current default platform is assumed.

Response

Supported Media Types

application/json

200 Response

successful operation

Root Schema : schema

Type: array

Show Source

Array of: object ConfigurationProperty

ConfigurationProperty model object.

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

Nested Schema : ConfigurationProperty

Type: object

ConfigurationProperty model object.

Show Source

category: string

Allowed Values: [ "Agent", "BeanAccessor", "ConfigManager", "DigestLoginModule", "Identity", "IssuedToken", "KerberosLoginModule", "KeystoreConfig", "SAML2LoginModule", "SAMLLoginModule", "TokenIssuerTrust", "SecureConversation", "STSConfig", "SubjectProperties", "UsernameAssertionLoginModule", "WSSDigestLoginModule", "X509LoginModule" ]

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.
name(required): string

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.

Example: agent.clock.skew
source: string

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}.
values(required): array values

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.

{
    "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."
}

Nested Schema : values

Type: array

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.

Show Source

Array of: string

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

Example:

['5000']

400 Response

User bad request, please correct input data and try again.

Root Schema : ResponseStatus

Type: object

ResponseStatus model object.

Show Source

MESSAGE: string

Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause.

Example: PolicySets [myPolicyset1, myPolicyset2] are successfully created.
STATUSCODE: string

Allowed Values: [ "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" ]

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

Example: 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 Response

Operation failed with unexpected error.

Root Schema : ResponseStatus

Type: object

ResponseStatus model object.

Show Source

MESSAGE: string

Detail message of the response, if response is successful, its a confirmation, otherwise it is an error message indicating the root cause.

Example: PolicySets [myPolicyset1, myPolicyset2] are successfully created.
STATUSCODE: string

Allowed Values: [ "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" ]

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

Example: 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."
}