Update TokenIssuer(s)
patch
/v2/trust/{trustname}/issuer
Update a list of TokenIssuers in a named {trustname} Trust document. Each TokenIssuermust supply its issuername and tokentype which are used to uniquely identify a TokenIssuer plus one or more its modifiable fields: enabled. Note, sub objects cannot be updated; they must be done by calling the APIs of each sub object respectively.
Request
Supported Media Types
- application/json
Path Parameters
-
trustname(required): string
Name of the Trust document.
The list of TokenIssuer objects to be updated.
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 TokenIssuerExample:
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.
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
Nested Schema : relyingparties
Type:
array
The list of all RelyingParty sub objects
Show Source
-
Array of:
object RelyingParty
RelyingParty Model Object.
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.
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.
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.
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
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