OAuth Client API
{ urn:com.soa.devconsole.api } OAuthClientApi
This API provides the ability to manage tokens and artifacts associated with OAuth clients.
POST/devconsole/sessionscreateSessionKey
Parameters
Accepts multipart/form-data
Name
Type
Description
Model
body
entity
base64Binary
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/devconsole/sessionscreateSessionKeyWithAppSecret
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
GET/devconsole/authpolicygetEffectiveAuthPolicy
Parameters
Accepts */*
Name
Type
Description
Model
apiVersionDN
query
string
environment
query
string
ImplementationCode
query
string
OperationName
query
string
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
AuthPolicies
AuthPolicies {
AuthPolicy {
JoseSecurityPolicy {
ProviderOUT {
Header {
ProviderIN {
HttpSecurityPolicy {
EndpointOAuthDetails {
OAuthTokenResourceURISettings {
OAuth20Settings {
OAuth10aSettings {
ApiSecurityPolicy {
AggregatePolicy {
AuthPolicy( Collection of AuthPolicy )
AggregatePolicy( Collection of AggregatePolicy )
}
AuthPolicy {
Type( AuthPolicyType )
JoseSecurityPolicy( JoseSecurityPolicy )
HttpSecurityPolicy( HttpSecurityPolicy )
PolicySubType( string )
OAuthDetails( EndpointOAuthDetails )
ApiSecurityPolicy( ApiSecurityPolicy )
Key( string )
Subject( Subject )
Name( string )
}
JoseSecurityPolicy {
Serialization( string )
HeaderParameterName( string )
DetachedPayload( boolean )
Scope( Collection of string )
EnforceOpenBanking( boolean )
ProviderOUT( ProviderOUT )
ProviderIN( ProviderIN )
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 )
}
Header {
Value( string )
Name( string )
}
ProviderIN {
EncryptSubjectCategoryUri( string )
SignedContent( boolean )
UseJWKSUrl( boolean )
EncryptSubjectCategory( string )
SignSubjectCategoryUri( string )
SignSubjectCategory( string )
EncryptedContent( boolean )
}
HttpSecurityPolicy {
RequireBasicAuth( boolean )
RequireClientCertificate( boolean )
}
EndpointOAuthDetails {
OAuthTokenResourceURISettings( OAuthTokenResourceURISettings )
OAuth20Settings( OAuth20Settings )
OAuth10aSupported( boolean )
Resource( Collection of string )
TokenEndpointParameters( Collection of string )
ClientAuthPolicyOption( Collection of string )
OAuth10aSettings( OAuth10aSettings )
AuthorizationEndpointParameters( Collection of string )
OAuthProvider( string )
PlatformAppIdentitiesInUse( boolean )
SupportedGrant( Collection of string )
OAuth20Supported( boolean )
}
OAuthTokenResourceURISettings {
OAuthTokenRequestURI( string )
OAuthTokenResourceURIOption( string )
}
OAuth20Settings {
TokenEndpointURL( anyURI )
TokenEndpointRequestVerb( string )
BearerTokenMethods( Collection of string )
AuthorizationEndpointURL( anyURI )
}
OAuth10aSettings {
TokenEndpointRequestVerb( string )
AuthorizationEndpointURL( anyURI )
AccessTokenEndpointURL( anyURI )
TokenParameterTransmissionMethods( Collection of string )
RequestTokenEndpointURL( anyURI )
}
ApiSecurityPolicy {
TokenLocations( Collection of string )
TokenAlgorithms( Collection of string )
SecureTokenRequired( boolean )
Signature( string )
AuthorizationHeaderScheme( string )
CookieName( string )
TokenParameterPrefix( string )
}
AggregatePolicy {
AuthPolicy( Collection of AuthPolicy )
PolicyEnforcementRequirement( string )
Name( string )
}
POST/devconsole/oauth/requestgetRequest
Parameters
Accepts text/xml application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v71+xml application/vnd.soa.v72+xml application/vnd.soa.v80+xml application/vnd.soa.v81+json application/vnd.soa.v81+xml
Name
Type
Description
Model
body
entity
ResourceRequest
ResourceRequest {
ContentType( string )
ClientIdentity( string )
QueryString( anyURI )
Verb( string, required )
TokenKey( string, required )
PostParameters( string )
Url( anyURI, required )
}
Reponse
Produces text/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
OAuthRequest
OAuthRequest {
OAuthRequestHeader {
OAuthRequestHeaders( Collection of OAuthRequestHeader )
QueryString( string )
}
OAuthRequestHeader {
Value( string )
Name( string )
}
POST/devconsole/oauth/requesttokengetRequestToken
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
apiVersionDN
form
apiKey
form
string
apiSecret
form
string
environment
form
string
operationName
form
string
policyKey
form
string
grantType
form
string
policyType
form
string
appRedirectUrl
form
string
sessionKey
form
string
appIdentityToken
form
string
providerName
form
string
scope
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
RequestTokenResponse
RequestTokenResponse {
AuthorizationUrl( anyURI )
State( string )
}
GET/devconsole/oauth/redirectgetFinalRedirectUrl
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/devconsole/oauth/accesstokengetAccessToken
Parameters
Name
Type
Description
Model
appIdentityToken
query
string
sessionKey
query
string
session_key
query
string
state
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
AccessTokenResponse
AccessTokenResponse {
State( string )
}
POST/devconsole/oauth/accesstokengetAccessTokenPOST
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
appIdentityToken
form
string
sessionKey
form
string
session_key
form
string
state
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
AccessTokenResponse
AccessTokenResponse {
State( string )
}
POST/devconsole/oauth/renewtokenrenewAccessTokenPOST
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
appIdentityToken
form
string
sessionKey
form
string
session_key
form
string
Reponse
Produces application/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
AccessTokenResponse
AccessTokenResponse {
State( string )
}