Client Services API
{ http://soa.com/wsdl/clientservices/1.0 } ClientServicesAPI
The client services API includes operations to support app developers, and also Test Client, in preparing request messages with the values that the API needs, so that the requests are suitable for the API Security Policy that the API is using.
POST/client/services/request/apisecuritypolicyimplementAPISecurityPolicy
Parameters
Accepts application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/json application/xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
APISecurityRequest
APISecurityRequest {
Message {
DynamicBindingParameters {
APISecurityPolicyChoices {
ClientIdentity( string )
Message( Message, required )
DynamicBindingParameters( DynamicBindingParameters, required )
APISecurityPolicyChoices( APISecurityPolicyChoices, required )
}
Message {
ContentType( string )
QueryString( anyURI )
Verb( string, required )
PostParameters( string )
Url( anyURI, required )
}
DynamicBindingParameters {
APIContractID( string )
OperationName( string )
Environment( string )
APIVersionID( string )
}
APISecurityPolicyChoices {
SecureTokenRequired( boolean )
TokenAlgorithm( string )
TokenLocation( TokenLocation )
AuthorizationHeaderScheme( string )
CookieName( string )
TokenParameterPrefix( string )
}
Reponse
Produces application/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/jsonapplication/xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
MessageTransformation
MessageTransformation {
Cookies {
Cookie {
Headers {
Header {
IncludeCookies( Cookies )
IncludeHeaders( Headers )
QueryString( string )
Payload( string )
}
Cookies {
Cookie( Collection of Cookie )
}
Cookie {
Value( string )
Name( string )
}
Headers {
Header( Collection of Header )
}
Header {
Value( string )
Name( string )
}
POST/client/services/request/josesecuritypolicyimplementJOSESecurityPolicy
Parameters
Accepts application/json application/xml application/vnd.soa.v84+json application/vnd.soa.v84+xml
Name
Type
Description
Model
body
entity
JosePolicyRequest
JosePolicyRequest {
Header {
JoseSecurityPolicy {
ProviderOUT {
ProviderIN {
Headers {
ClientIdentity( string )
ClaimHeaders( Collection of Header )
JoseSecurityPolicy( JoseSecurityPolicy, required )
EncryptionAlgorithm( string )
ServiceKey( string )
Payload( string, required )
SignatureAlgorithm( string )
EncryptionKeyMgmtAlgorithm( string )
ProviderType( ProviderType, required )
ResponseHeaders( Headers )
PrivateHeaders( Collection of Header )
}
Header {
Value( string, required )
Name( string, required )
}
JoseSecurityPolicy {
Serialization( string, required )
HeaderParameterName( string )
DetachedPayload( boolean )
Scope( Collection of string )
EnforceOpenBanking( boolean )
ProviderOUT( ProviderOUT, required )
ProviderIN( ProviderIN, required )
OpenBankingVersion( string )
AppendixFDetachedContent( boolean )
}
ProviderOUT {
EncryptSubjectCategoryUri( string )
SignContent( boolean )
EncryptSubjectCategory( string )
SignSubjectCategoryUri( string )
EncryptContent( boolean )
EncryptionAlgorithm( string )
SignatureAlgorithm( string )
EncryptionKeyMgmtAlgorithm( string )
SignSubjectCategory( string )
CustomHeaders( Collection of Header )
PrivateHeaders( Collection of Header )
}
ProviderIN {
EncryptSubjectCategoryUri( string )
SignedContent( boolean )
UseJWKSUrl( boolean )
EncryptSubjectCategory( string )
SignSubjectCategoryUri( string )
SignSubjectCategory( string )
EncryptedContent( boolean )
}
Headers {
Header( Collection of Header, required )
}
Reponse
Produces application/jsonapplication/xmlapplication/vnd.soa.v84+jsonapplication/vnd.soa.v84+xml
Status Code
Reason
Model
200
Success
MessageTransformation
MessageTransformation {
Cookies {
Cookie {
Headers {
Header {
IncludeCookies( Cookies )
IncludeHeaders( Headers )
QueryString( string )
Payload( string )
}
Cookies {
Cookie( Collection of Cookie )
}
Cookie {
Value( string )
Name( string )
}
Headers {
Header( Collection of Header )
}
Header {
Value( string )
Name( string )
}
POST/client/services/request/client/identityassignClientIdentityWithSharedSecretPOST
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
body
entity
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/client/services/request/client/identityassignClientIdentity
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
PUT/client/services/request/client/identityassignClientIdentityWithSharedSecretPUT
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
body
entity
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
POST/client/services/request/keystore/aliasloadAliasesForKeystore
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
