REST API for Oracle Web Services Manager

Update Trust(s)

patch

/v2/trust

Update a list of Trust documents.

Request

Supported Media Types

application/json

The list of Trust objects (without any sub objects) with new values for those updatable fileds, for now only displayname is uptable.

Root Schema : schema

Type: array

Show Source

Array of: object Trust

Trust Model Object

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

Nested Schema : Trust

Type: object

Trust Model Object

Show Source

displayname(required): string

The display name of a Trust document

Example: display name 1
issuers: array issuers

The list of all TokenIssuer sub objects
tokenAttributeRules: array tokenAttributeRules

The list of all TokenAttributeRule sub objects
trustname(required): string

Name of a Trust document. It is the unique identifier used to identify a Trust

Example: myFirstTrustDoc

{
    "type":"object",
    "required":[
        "displayname",
        "trustname"
    ],
    "properties":{
        "trustname":{
            "type":"string",
            "example":"myFirstTrustDoc",
            "description":"Name of a Trust document. It is the unique identifier used to identify a Trust"
        },
        "displayname":{
            "type":"string",
            "example":"display name 1",
            "description":"The display name of a Trust document"
        },
        "issuers":{
            "type":"array",
            "description":"The list of all TokenIssuer sub objects",
            "items":{
                "$ref":"#/definitions/TokenIssuer"
            }
        },
        "tokenAttributeRules":{
            "type":"array",
            "description":"The list of all TokenAttributeRule sub objects",
            "items":{
                "$ref":"#/definitions/TokenAttributeRule"
            }
        }
    },
    "description":"Trust Model Object"
}

Nested Schema : issuers

Type: array

The list of all TokenIssuer sub objects

Show Source

Array of: object TokenIssuer

TokenIssuer Model Object

{
    "type":"array",
    "description":"The list of all TokenIssuer sub objects",
    "items":{
        "$ref":"#/definitions/TokenIssuer"
    }
}

Nested Schema : tokenAttributeRules

Type: array

The list of all TokenAttributeRule sub objects

Show Source

Array of: object TokenAttributeRule

TokenAttributeRule Model Object

{
    "type":"array",
    "description":"The list of all TokenAttributeRule sub objects",
    "items":{
        "$ref":"#/definitions/TokenAttributeRule"
    }
}

Nested Schema : TokenIssuer

Type: object

TokenIssuer Model Object

Show Source

discoveryinfo: object DiscoveryInfo

DiscoveryInfo Model Object.
enabled: string

Allowed Values: [ "true", "false" ]

Indicates if an Issuer is enabled or not.

Example: true
issuername(required): string

Name of a TokenIssuer. It is one of the unique identifier used to identify a TokenIssuer

Example: http://abc.com
relyingparties: array relyingparties

The list of all RelyingParty sub objects
tokentype(required): string

Allowed Values: [ "jwt", "saml.hok", "saml.sv" ]

Type of the Issuer's token, must be one of the predefine values.

Example: jwt
trustedkey: object TrustedKey

TrustedKey Model Object.

{
    "type":"object",
    "required":[
        "issuername",
        "tokentype"
    ],
    "properties":{
        "issuername":{
            "type":"string",
            "example":"http://abc.com",
            "description":"Name of a TokenIssuer. It is one of the unique identifier used to identify a TokenIssuer"
        },
        "tokentype":{
            "type":"string",
            "example":"jwt",
            "description":"Type of the Issuer's token, must be one of the predefine values.",
            "enum":[
                "jwt",
                "saml.hok",
                "saml.sv"
            ]
        },
        "enabled":{
            "type":"string",
            "example":"true",
            "description":"Indicates if an Issuer is enabled or not.",
            "enum":[
                "true",
                "false"
            ]
        },
        "discoveryinfo":{
            "description":"The DiscoveryInfo sub object",
            "$ref":"#/definitions/DiscoveryInfo"
        },
        "trustedkey":{
            "description":"The TrustedKeysub object",
            "$ref":"#/definitions/TrustedKey"
        },
        "relyingparties":{
            "type":"array",
            "description":"The list of all RelyingParty sub objects",
            "items":{
                "$ref":"#/definitions/RelyingParty"
            }
        }
    },
    "description":"TokenIssuer Model Object"
}

Nested Schema : DiscoveryInfo

Type: object

DiscoveryInfo Model Object.

Show Source

baseUrl: string

URL of the Issuer, must be in the form of a URL. It is required only if discoveryUrl is not set.
discoveryUrl: string

URL that indicates where to discover the Issuer, must be in the form of a URL. It is required only if baseUrl is not set.
idcsClientCsfkey: string

IDCS Client csf-key, only valid if Issuer is IDCS
idcsClientTenant: string

IDCS Client tenant, only valid if Issuer is IDCS

{
    "type":"object",
    "properties":{
        "baseUrl":{
            "type":"string",
            "description":"URL of the Issuer, must be in the form of a URL. It is required only if discoveryUrl is not set."
        },
        "discoveryUrl":{
            "type":"string",
            "description":"URL that indicates where to discover the Issuer, must be in the form of a URL. It is required only if baseUrl is not set."
        },
        "idcsClientCsfkey":{
            "type":"string",
            "description":"IDCS Client csf-key, only valid if Issuer is IDCS"
        },
        "idcsClientTenant":{
            "type":"string",
            "description":"IDCS Client tenant, only valid if Issuer is IDCS"
        }
    },
    "description":"DiscoveryInfo Model Object."
}

Nested Schema : relyingparties

Type: array

The list of all RelyingParty sub objects

Show Source

Array of: object RelyingParty

RelyingParty Model Object.

{
    "type":"array",
    "description":"The list of all RelyingParty sub objects",
    "items":{
        "$ref":"#/definitions/RelyingParty"
    }
}

Nested Schema : TrustedKey

Type: object

TrustedKey Model Object.

Show Source

keyidentifiers: array keyidentifiers

A list of KeyIdentifier sub objects. They are either fetched from location that is specified by mdurl or being manually added.
keys: string

Read Only: true
keystype: string

Read Only: true
mdurl: string

Metadata URL of a TrustedKey. This field is only valid when the tokentype of its SwaggerObject.TOKENISSUER is jwt.
refreshinterval: string

An integer value indicates how often key identifiers need to be refetched from location specified by field mdurl
trust: string

Allowed Values: [ "dns.jwt", "jwk.jwt", "idcs.dns.jwt", "idcs.jwk.jwt" ]

Trust type of TrustedKey. This field is only valid when the tokentype of its SwaggerObject.TOKENISSUER is jwt. and mdurl is set. It must be one of the allowed predefined value.

{
    "type":"object",
    "properties":{
        "mdurl":{
            "type":"string",
            "description":"Metadata URL of a TrustedKey. This field is only valid when the tokentype of its SwaggerObject.TOKENISSUER is jwt."
        },
        "refreshinterval":{
            "type":"string",
            "description":"An integer value indicates how often key identifiers need to be refetched from location specified by field mdurl"
        },
        "trust":{
            "type":"string",
            "description":"Trust type of TrustedKey. This field is only valid when the tokentype of its SwaggerObject.TOKENISSUER is jwt. and mdurl is set. It must be one of the allowed predefined value.",
            "enum":[
                "dns.jwt",
                "jwk.jwt",
                "idcs.dns.jwt",
                "idcs.jwk.jwt"
            ]
        },
        "keystype":{
            "type":"string",
            "readOnly":true
        },
        "keys":{
            "type":"string",
            "readOnly":true
        },
        "keyidentifiers":{
            "type":"array",
            "description":"A list of KeyIdentifier sub objects. They are either fetched from location that is specified by mdurl or being manually added.",
            "items":{
                "$ref":"#/definitions/KeyIdentifier"
            }
        }
    },
    "description":"TrustedKey Model Object."
}

Nested Schema : RelyingParty

Type: object

RelyingParty Model Object.

Show Source

rptype(required): string

Allowed Values: [ "csfkey", "literal" ]

Type of a RelyingParty.

Example: liberal
rpvalue(required): string

Value of a RelyingParty.

{
    "type":"object",
    "required":[
        "rptype",
        "rpvalue"
    ],
    "properties":{
        "rptype":{
            "type":"string",
            "example":"liberal",
            "description":"Type of a RelyingParty.",
            "enum":[
                "csfkey",
                "literal"
            ]
        },
        "rpvalue":{
            "type":"string",
            "description":"Value of a RelyingParty."
        }
    },
    "description":"RelyingParty Model Object."
}

Nested Schema : keyidentifiers

Type: array

A list of KeyIdentifier sub objects. They are either fetched from location that is specified by mdurl or being manually added.

Show Source

Array of: object KeyIdentifier

KeyIdentifier Model Object.

{
    "type":"array",
    "description":"A list of KeyIdentifier sub objects. They are either fetched from location that is specified by mdurl or being manually added.",
    "items":{
        "$ref":"#/definitions/KeyIdentifier"
    }
}

Nested Schema : KeyIdentifier

Type: object

KeyIdentifier Model Object.

Show Source

enabled: string

Allowed Values: [ "true", "false" ]

ture indicates KeyIdentifier is enabled, false otherwise, default is true.
keytype(required): string

Allowed Values: [ "x509certificate", "symmetricKey", "publicKey" ]

Key type of an KeyIdentifier. It must be one of the predefined allowable values, which one is valid depends on its Issuer's token type. The valid combinations are: 1. keytype must bex509certificate if its parent TokenIssuer is either saml.hok or saml.sv. 2. keytype can be x509certificate,symmetricKey or publicKey if its parent TokenIssuer is jwt.

Example: x509certificate
value(required): string

Value of an KeyIdentifier
valuetype(required): string

Allowed Values: [ "dn", "alias", "csfkey", "kid" ]

Value type of an KeyIdentifier, First it must be one of the predefined allowable values, and second, which one is valid depends on its corresponding field keytype The valid combinations are: it can be dn or alias if its keytype is x509certificate it can only be csfkey if its keytype is symmetricKey it can only be kid if its keytype is publicKey

{
    "type":"object",
    "required":[
        "keytype",
        "value",
        "valuetype"
    ],
    "properties":{
        "keytype":{
            "type":"string",
            "example":"x509certificate",
            "description":"Key type of an KeyIdentifier. It must be one of the predefined allowable values, which one is valid depends on its Issuer's token type. The valid combinations are: \n1. keytype must bex509certificate if its parent TokenIssuer is either saml.hok or saml.sv.\n2. keytype can be x509certificate,symmetricKey or publicKey if its parent TokenIssuer is jwt.\n",
            "enum":[
                "x509certificate",
                "symmetricKey",
                "publicKey"
            ]
        },
        "valuetype":{
            "type":"string",
            "description":"Value type of an KeyIdentifier, First it must be one of the predefined allowable values, and second, which one is valid depends on its corresponding field keytype The valid combinations are: \n it can be dn or alias if its keytype is x509certificate\n it can only be csfkey if its keytype is symmetricKey\n it can only be kid if its keytype is publicKey\n",
            "enum":[
                "dn",
                "alias",
                "csfkey",
                "kid"
            ]
        },
        "value":{
            "type":"string",
            "description":"Value of an KeyIdentifier"
        },
        "enabled":{
            "type":"string",
            "description":"ture indicates KeyIdentifier is enabled, false otherwise, default is true.",
            "enum":[
                "true",
                "false"
            ]
        }
    },
    "description":"KeyIdentifier Model Object."
}

Nested Schema : TokenAttributeRule

Type: object

TokenAttributeRule Model Object

Show Source

attributes: array attributes

The list of all TokenAttribute sub objects
identifier(required): string

Identifier of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule

Example: identifier1
issuername(required): string

Name of the token issuer of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule

Example: http://abc.com
nameid: object NameId

NameId Model Object
proxy: object Proxy

Proxy Model Object.
virtualuser: object VirtualUser

VirtualUser Model Object.

{
    "type":"object",
    "required":[
        "identifier",
        "issuername"
    ],
    "properties":{
        "issuername":{
            "type":"string",
            "example":"http://abc.com",
            "description":"Name of the token issuer of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule"
        },
        "identifier":{
            "type":"string",
            "example":"identifier1",
            "description":"Identifier of a TokenAttributeRule. It is one of the two unique identifiers used to identify a TokenAttributeRule"
        },
        "proxy":{
            "example":"true",
            "description":"The Proxy sub object",
            "$ref":"#/definitions/Proxy"
        },
        "virtualuser":{
            "description":"The VirtualUser sub object",
            "$ref":"#/definitions/VirtualUser"
        },
        "nameid":{
            "description":"The NameIdsub object",
            "$ref":"#/definitions/NameId"
        },
        "attributes":{
            "type":"array",
            "description":"The list of all TokenAttribute sub objects",
            "items":{
                "$ref":"#/definitions/TokenAttribute"
            }
        }
    },
    "description":"TokenAttributeRule Model Object"
}

Nested Schema : attributes

Type: array

The list of all TokenAttribute sub objects

Show Source

Array of: object TokenAttribute

TokenAttribute Model Object

{
    "type":"array",
    "description":"The list of all TokenAttribute sub objects",
    "items":{
        "$ref":"#/definitions/TokenAttribute"
    }
}

Nested Schema : NameId

Type: object

NameId Model Object

Show Source

filter: array filter

Filter
mapping: object AttributeMapping

AttributeMapping Model Object.
name(required): string

Name of a NameId

Example: myTokenAttributeName1

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "filter":{
            "type":"array",
            "example":"['filter1', 'filter2']",
            "description":"Filter",
            "items":{
                "type":"string"
            }
        },
        "mapping":{
            "description":"The AttributeMappingsub object",
            "$ref":"#/definitions/AttributeMapping"
        },
        "name":{
            "type":"string",
            "example":"myTokenAttributeName1",
            "description":"Name of a NameId"
        }
    },
    "description":"NameId Model Object"
}

Nested Schema : Proxy

Type: object

Proxy Model Object.

Show Source

proxyhost: string

The host of a Proxy in a TokenAttributeRule
proxyport: string

The port of a Proxy in a TokenAttributeRule

{
    "type":"object",
    "properties":{
        "proxyhost":{
            "type":"string",
            "description":"The host of a Proxy in a TokenAttributeRule"
        },
        "proxyport":{
            "type":"string",
            "description":"The port of a Proxy in a TokenAttributeRule"
        }
    },
    "description":"Proxy Model Object."
}

Nested Schema : VirtualUser

Type: object

VirtualUser Model Object.

Show Source

defaultRoles: array defaultRoles

An array of default roles of a VirtualUser
enabled: string

Allowed Values: [ "true", "false" ]

Indicates if a VirtualUser is enabled or not.

Example: true
tokenRoleAttributes: array tokenRoleAttributes
tokenRoleMappings: array tokenRoleMappings

A list of TokenRoleMapping sub objects

{
    "type":"object",
    "properties":{
        "enabled":{
            "type":"string",
            "example":"true",
            "description":"Indicates if a VirtualUser is enabled or not.",
            "enum":[
                "true",
                "false"
            ]
        },
        "defaultRoles":{
            "type":"array",
            "description":"An array of default roles of a VirtualUser",
            "items":{
                "type":"string"
            }
        },
        "tokenRoleMappings":{
            "type":"array",
            "description":"A list of TokenRoleMapping sub objects",
            "items":{
                "$ref":"#/definitions/TokenRoleMapping"
            }
        },
        "tokenRoleAttributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"VirtualUser Model Object."
}

Nested Schema : TokenAttribute

Type: object

TokenAttribute Model Object

Show Source

filter: array filter

Filter
mapping: object AttributeMapping

AttributeMapping Model Object.
name(required): string

Name of a TokenAttribute

Example: myTokenAttributeName1

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "filter":{
            "type":"array",
            "example":"['filter1', 'filter2']",
            "description":"Filter",
            "items":{
                "type":"string"
            }
        },
        "mapping":{
            "description":"The AttributeMappingsub object",
            "$ref":"#/definitions/AttributeMapping"
        },
        "name":{
            "type":"string",
            "example":"myTokenAttributeName1",
            "description":"Name of a TokenAttribute"
        }
    },
    "description":"TokenAttribute Model Object"
}

Nested Schema : filter

Type: array

Filter

Show Source

Array of: string

{
    "type":"array",
    "example":"['filter1', 'filter2']",
    "description":"Filter",
    "items":{
        "type":"string"
    }
}

Example:

['filter1', 'filter2']

Nested Schema : AttributeMapping

Type: object

AttributeMapping Model Object.

Show Source

userAttribute(required): string

User attribute

Example: myUserAttr1
userMappingAttribute(required): string

User mapping attribute.

Example: myUserMappingAttr1

{
    "type":"object",
    "required":[
        "userAttribute",
        "userMappingAttribute"
    ],
    "properties":{
        "userAttribute":{
            "type":"string",
            "example":"myUserAttr1",
            "description":"User attribute"
        },
        "userMappingAttribute":{
            "type":"string",
            "example":"myUserMappingAttr1",
            "description":"User mapping attribute."
        }
    },
    "description":"AttributeMapping Model Object."
}

Nested Schema : filter

Type: array

Filter

Show Source

Array of: string

{
    "type":"array",
    "example":"['filter1', 'filter2']",
    "description":"Filter",
    "items":{
        "type":"string"
    }
}

Example:

['filter1', 'filter2']

Nested Schema : defaultRoles

Type: array

An array of default roles of a VirtualUser

Show Source

Array of: string

{
    "type":"array",
    "description":"An array of default roles of a VirtualUser",
    "items":{
        "type":"string"
    }
}

Nested Schema : tokenRoleAttributes

Type: array

Show Source

Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : tokenRoleMappings

Type: array

A list of TokenRoleMapping sub objects

Show Source

Array of: object TokenRoleMapping

TokenRoleMapping Model Object.

{
    "type":"array",
    "description":"A list of TokenRoleMapping sub objects",
    "items":{
        "$ref":"#/definitions/TokenRoleMapping"
    }
}

Nested Schema : TokenRoleMapping

Type: object

TokenRoleMapping Model Object.

Show Source

mappingRoles(required): array mappingRoles

List of role mappings.
tokenRole(required): string

Role of the token.

Example: sampleTRole1

{
    "type":"object",
    "required":[
        "mappingRoles",
        "tokenRole"
    ],
    "properties":{
        "tokenRole":{
            "type":"string",
            "example":"sampleTRole1",
            "description":"Role of the token."
        },
        "mappingRoles":{
            "type":"array",
            "example":"['roleMapping1', 'roleMpping2']",
            "description":"List of role mappings.",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"TokenRoleMapping Model Object."
}

Nested Schema : mappingRoles

Type: array

List of role mappings.

Show Source

Array of: string

{
    "type":"array",
    "example":"['roleMapping1', 'roleMpping2']",
    "description":"List of role mappings.",
    "items":{
        "type":"string"
    }
}

Example:

['roleMapping1', 'roleMpping2']

Response

Supported Media Types

application/json

200 Response

successful operation

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

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