Update a Specific Named PolicySet
patch
/v2/policyset/{name}
Update the PolicySet with new values for those attributes that need to be updated. PolicySet name that uniquely identifies the PolicySet is specified in the request path therefore needs not be included in the body.
Request
Supported Media Types
- application/json
Path Parameters
-
name(required): string
The name of the PolicySet
A PolicySet model object containing only fields(name and value pairs) that are to be upated. Fields that are omitted will stay unchanged.
Root Schema : PolicySet
Type:
object
PolicySet Model Object.
Show Source
-
configOverrides:
array configOverrides
ConfigOverride sub objects of a PolicySet. This is a list of all the unscoped ConfigOverride of a PolicySet. These override properties are not scoped to a specific PolicyReference; they should apply to all PolicyReferences.
-
constraint:
string
Allowed Values:
[ "HTTPHeader(\"VIRTUAL_HOST_TYPE\": \"external\")", "HTTPHeader(\"VIRTUAL_HOST_TYPE\": \"internal\")" ]
Constraint of a PolicySet, it can have a constraint set against http request header, for now we have VIRTUAL_HOST_TYPE and its value can be either external or internal.Example:HTTPHeader('VIRTUAL_HOST_TYPE', 'external')
-
description:
string
Description of a PolicySetExample:
This is the policy set one
-
name(required):
string
Name of a PolicySet. It is a unique identifier used to identify a PolicySetExample:
myPolicySet1
-
policyReferences:
array policyReferences
PolicyReference sub objects of a PolicySet. This is a list of all the PolicyReferences of a PolicySet. A PolicyReference is the same as a policy attachement.
-
scope(required):
string
Allowed Values:
[ "Domain('expression')", "Application('expression')", "Partition('expression')", "Module('expression')", "Composite('expression')", "Jobname('expression')", "Path('expression')", "Reference('expression')", "Service('expression')", "Component('expression')", "Port('expression')", "EJBName('expression')", "PortType('expression')" ]
Expression that represents the scope of resources to which the policy set will be attached. The scope expression must conform to function format(' ') where function determines the characteristics for the policy subject. example:"Domain('base_domain')". A function could be one of the following listed in the allowable values. Each function may appear only once, but multiple functions can be provided by separating them with the standard "and" operator. Each function accepts a single argument which must be provided and this argument will be interpreted as a string that would be matched against the corresponding characteristic of the policy subject. The special character "*" may be used as wildcard character to indicate that any number of characters may occur in its place and this character may occur any number of times and at any position within the argument string. Example: Domain('*') Example:Domain('*')
-
status:
string
Allowed Values:
[ "enabled", "disabled" ]
Status of a PolicySet that specifies whether a PolicySet is enabled. If you omit it during creation, the PolicySet is enabled.Example:enabled
-
type(required):
string
Allowed Values:
[ "sca-component", "sca-reference", "sca-rest-reference", "sca-rest-service", "sca-service", "sca-jca-service", "sca-jca-reference", "ws-service", "ws-client", "ws-connection", "ws-callback", "job-callback", "job-invoke", "job-rest-invoke", "job-rest-service", "rest-connection", "rest-client", "rest-resource", "business-jca-service", "business-rest-service", "business-service", "proxy-jca-service", "proxy-rest-service", "proxy-service" ]
The type of policy subject to which the policy set applies. The type of policy subject must be one of the allowable values.Example:ws-service
Nested Schema : configOverrides
Type:
array
ConfigOverride sub objects of a PolicySet. This is a list of all the unscoped ConfigOverride of a PolicySet. These override properties are not scoped to a specific PolicyReference; they should apply to all PolicyReferences.
Show Source
-
Array of:
object ConfigOverride
ConfigOverride Model Object.
Nested Schema : policyReferences
Type:
array
PolicyReference sub objects of a PolicySet. This is a list of all the PolicyReferences of a PolicySet. A PolicyReference is the same as a policy attachement.
Show Source
-
Array of:
object PolicyReference
PolicyReference model object.
Nested Schema : ConfigOverride
Type:
object
ConfigOverride Model Object.
Show Source
-
name(required):
string
Name of the property to be over written.Example:
csf-key
-
value(required):
string
New value of the property used to override.Example:
myEncryptCsfkey
Nested Schema : PolicyReference
Type:
object
PolicyReference model object.
Show Source
-
category:
string
-
configOverrides:
array configOverrides
A list of ConfigOverrides that apply to this particular PolicyReference (also called policy attachment) only.
-
source:
string
Source that indicates if its Global or Tenant
-
status:
string
Allowed Values:
[ "enabled", "disabled" ]
The status indicating if the policy attachment is in effective, it is effective if the status is enabled, is ineffective otherwise. If it is omitted during creation, it is treated as enabled.Example:enabled
-
uri(required):
string
URI of a policy attached or to be attached to a named PolicySetExample:
oracle/wss_username_token_service_policy
Nested Schema : configOverrides
Type:
array
A list of ConfigOverrides that apply to this particular PolicyReference (also called policy attachment) only.
Show Source
-
Array of:
object ConfigOverride
ConfigOverride Model Object.
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=ProxyExample:20001
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=ProxyExample:20001
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=ProxyExample:20001