User Operations Inquiry
User Operations Inquiry
User Operations Inquiry is a jXchange service designed to provide users with a method to determine the levels of accessibility given to a specific authenticated user.
Message Flow
In jXchange, the User Operations Inquiry service uses a typical exchange of MType messages to determine the
levels of accessibility given to a specific authenticated user.
Primary Request
The third-party consumer forwards the UsrOperInqRq_MType message to the
service provider.
The message contains the following simple element:
- UsrId
The message contains the following complex elements:
Custom_CTypeMsgRqHdr_CType
The message contains the following array:
UsrOperInqRqRecArray_AType
Primary Response
The service provider returns the UsrOperInqRs_MType message to the
third-party consumer.
The message contains the following simple element:
- UsrId
The message contains the following complex elements:
Custom_CTypeMsgRsHdr_CType
The message contains the following array:
UsrOperInqRsRecArray_AType
User Operations Inquiry Behavior
The service provider does not apply any accessibility policies when a user alias is not provided in the XML document body.
The service provider returns a fault when an invalid user alias is provided in the XML document body and when a consumer wants to be reactive to user accessibility rights.
The UsrOperInqRq_MType request message allows for multiple
inquiries for the same user identification with an array. The inquiry allows a consumer to
cache the policies, at a high level, and apply the accessibility rights for a user for all
operations specific to that user's role.
The consumer can submit the account identification and/or the customer identification for a specific operation to determine in advance if the end user has the rights to the account and/or customer.
The AuthenUsrCred is leveraged for submission of the end-user to the service provider. So, the AuthenUsrCred element and the UsrId element are a documented choice statement and are both optional, but one is required for the service.
The attribute Rstr references the element of the same name
and is a closed enumerator with the following canonical values:
- NoAccess - Access is denied. This attribute value can exist at the parent node as well as the element node.
- NoAccessPart - Access is denied as a default for all the nodes related to the parent node, and any of the related nodes could override the accessibility setting at the parent node. This attribute value can only exist at a parent node.
- ReadWrite - Full read and write access to any of the nodes. This is the default value.
- ReadWritePart - Full read and write access for all the nodes related to the parent node, and any of the related nodes could override the accessibility setting at the parent node. This attribute value can only exist at a parent node.
- ReadOnly - Read-only to any of the nodes.
- ReadOnlyPart - Read-only as a default for all of the nodes related to the parent node, and any of the related nodes could override the accessibility setting at the parent node. This attribute value can only exist at a parent node.
- Hid - Hide all of the nodes.
The canonical values that are prefixed with Part(Partial) convey to the consumer that overrides can exist for any of the proceeding nodes. These canonical values can never exist at an element node.
The elements in the XML body are decorated with an attribute that conveys
restrictions for an element. However, the data pertaining to the element is delivered when
the service provider conveys to the consumer that the data element must be masked. For
example, the current balance with restrictions could appear as CurBal Rstr
= NoAccess>1000.00</Curbal>.
The complex element in the XML body that wraps all of the response delta elements is decorated with an attribute that conveys restrictions exist for the complex when the user does not have access to the account/customer. However, the data pertaining to all of the elements in the complex can still be delivered. For example: the account search complex with the account identifications with restrictions appears as:
<AcctSrchRec Rstr = "NoAccess">
<AccountId>
…<AcctId>12345</AcctId>
….….…<AcctType>D</AcctType>
….….…</AccountId>
….….…<CustId>B--5--</CustId>
….….…<ProdCode>RC</ProdCode>
</AcctSrchRec>UsrOperInqRq_MType
UsrOperInqRq_MType is a message
MType element.
Contains:
Custom_CTypeMsgRqHdr_CTypeUsrOperInqRqRecArray_AType
Simple Elements
The following simple elements are contained within this message.
- UsrId
- The user ID which the consumer would like the service provider to use to authenticate with. It is a user ID that the provider understands.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRqHdr_CType
MsgRqHdr_CType is a complex CType element. This is
the default message request header.
Contains:
AuthenUsrCred_CTypejXchangeHdr_CType
Simple Elements
The following simple elements are contained within this complex.
- AuthenProdCred
- Authentication of the Consumer Product Credentials in the form of a WS Security element that contains a single SAML V2.0 Assertion.
AuthenUsrCred_CType
AuthenUsrCred_CType is a complex CType element. This element represents authentication of the end-user credentials in
the form of a WS Security element that contains a single SAML V2.0
Assertion.
Simple Elements
The following simple elements are contained within this complex.
- Security
- Defines the wsse:Security SOAP header element per section 4.
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.- BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
UsrOperInqRqRecArray_AType
UsrOperInqRqRecArray_AType is an
array AType element. This is an array of inputs for the
user operator inquiry request.
Contains:
UsrOperInqRqRec_CType
UsrOperInqRqRec_CType
UsrOperInqRqRec_CType is a complex
CType element.
Contains:
AccountId_CTypeCustomUsrOperInqRec_CTypereferencesCustom_CTypeOperFilterArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- Oper
- jXchange operations. Canonical Values are:
- AcctAnlysTrnAdd
- AcctAnlysTrnMod
- AcctInq
- AcctMod
- AcctReconItemMod
- ACHFltrAdd
- ACHFltrMod
- AddrAdd
- AddrMod
- CRMActAdd
- CRMActInq
- CRMActMod
- CRMActSrch
- CRMCustSrch
- CRMEventAdd
- CRMEventInq
- CRMEventMod
- CRMEventSrch
- CRMPotSaleSrch
- CRMProspAdd
- CRMProspInq
- CRMProspMod
- CRMProspSrch
- CRMReferAdd
- CRMReferInq
- CRMReferMod
- CRMReferSrch
- CustInq
- CustMod
- CustMsgAdd
- CustMsgMod
- DocImgAdd
- DocImgMod
- EFTCardAdd
- EFTCardInq
- EFTCardMod
- IntnetFinInstIdAdd
- IntnetFinInstIdInq
- IntnetFinInstIdMod
- IntnetFinInstIdPINMod
- StopChkAdd
- StopChkMod
TrnAdd- WireTrnAdd
- WireTrnInq
- WireTrnMod
- WorkflowInstcMod
- WorkflowInstcSrch
- WorkflowInstcStart
- XferAdd
- XferMod
AccountId_CType
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child
node. Canonical values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
CustomUsrOperInqRecComplex
Custom_CType is a complex CType element.
This element is optional.
CustomUsrOperInqRecComplex references
Custom_CType.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
OperFilterArray_AType
OperFilterArray_AType is an array
AType element. It is an array describing the applicable operation
filters.
Contains:
OperFilterInfo_CType
OperFilterInfo_CType
OperFilterInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OperFilterType
- Operation filters. Canonical values are:
AcctModAcctType
AddrAddAddrCatUseAddrCat2Use
AddrModAddrCatUseAddrCat2Use
- CRMActAdd
- CRMActType
- CRMActInq
- CRMActType
- CRMActMod
- CRMActType
- CRMActSrch
- CRMActType
- CRMEventAdd
- CRMEventType
- CRMEventInq
- CRMEventType
- CRMEventMod
- CRMEventType
- CRMEventSrch
- CRMEventType
CustMsgAddMsgTypeAcctType
CustMsgModMsgTypeAcctType
StopChkAddAcctType
TrnAddBrCodeGLProdCodeGLCostCtr
XferAddXferTypeAcctType
XferModXferTypeAcctType
- OperFilterVal
- The operation filter value. Contains the Rstr attribute.
UsrOperInqRs_MType
UsrOperInqRs_MType is a message
MType element.
Contains:
Custom_CTypeMsgRsHdr_CTypeUsrOperInqRsRecArray_AType
Simple Elements
The following simple elements are contained within this message.
- UsrId
- The user ID which the consumer would like the service provider to use to authenticate with. It is a user ID that the provider understands.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
MsgRsHdr_CType
MsgRsHdr_CType is a complex
CType element. This is the default message response
header.
Contains:
jXchangeHdr_CTypeMsgRecInfoArray_AType
jXchangeHdr_CType
jXchangeHdr_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- AuditUsrId
- The user ID that the consumer would like written in the audit as performing the requested service. It varies, but it could be the same as the user ID. It is not used to authenticate. It is used to audit the Soap Header Fault.
- AuditWsId
- The workstation ID that the consumer would like written in the audit as performing the requested service for the Soap Header Fault. It varies, but it could be the same as the user ID.
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.- BusCorrelId
- The correlation identification as related to business functions and activities.
- ConsumerName
- The name of the service consumer (business name) for the Soap Header Fault.
- ConsumerProd
- The name of the product which is consuming the service (business product name) for the Soap Header Fault.
- InstEnv
- An identification provided by the consumer that defines the
environment in which the institution is operating. Canonical values are:
- Prod
- InstRtId
- The identification of the entity of the submitted message. A
financial institution entity uses the routing transit or nine-digit number
assigned to financial institutions for routing as assigned by the American
Bankers Association. Any leading zeros must be provided for a complete routing
and transit number. A non-financial institution entity should use a mutually
agreed upon identification that must contain at least one non-integer character.
The canonical value is JHA.
The element is required in all message requests.
- jXLogTrackingId
- An identification provided by jXchange to be able to trace the request and response of a message from the third-party gateway, internal gateway, and service provider for the Soap Header Fault.
- JxVer
- Contains the version jXchange is running for the Soap Header Fault.
- ValidConsmName
- The consumer name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table. The canonical value is: JHA.
- ValidConsmProd
- The consumer product name that can be validated by enterprise governance. The canonical values are managed in a consumer/product enterprise table.
- WorkflowCorrelId
- The correlation identification as related to workflow functions and activities.
jXchangeHdr_CType Deprecation Details
- AuthenUsrId
The user ID which the consumer would like the service provider to authenticate with for the Soap Header Fault. It is a user ID that the provider understands.
This element deprecates in accordance with XSD contract tenets. Effective date: 2017–01–01. The new complex element for user authentication credentials was added to both the Search Message Request Header
SrchMsgRqHdr_CTypeand the Message Request HeaderMsgRqHdr_CType. AuthenUsrId is ignored by the service providers when the authentication user credentialsAuthenUsrCred_CTypepackage is delivered. The expectation is that the password credentials and the user name token are provided in the authentication user credential complex element in accordance with the standards established by WS-Security.
MsgRecInfoArray_AType
MsgRecInfoArray_AType is an array
AType element. This is an array of messages that can be
returned in a response.
Contains:
MsgRec_CType
MsgRec_CType
MsgRec_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- ErrCat
- The Soap Header Fault error category.
- ErrCode
- The error code.
- ErrDesc
- The Soap Header Fault error description.
- ErrElem
- The Soap Header Fault when an error or fault occurs. This optional element contains the element which is causing the error condition.
- ErrElemVal
- The Soap Header Fault when an error or fault occurs. This optional element contains the value of the element which is causing the error condition.
- ErrLoc
- The Soap Header Fault error location. This is typically the program that generated the error condition.
UsrOperInqRsRecArray_AType
UsrOperInqRsRecArray_AType is an
array AType element. This is an array of responses for the
user operator inquiry.
Contains:
UsrOperInqRsRec_CType
UsrOperInqRsRec_CType
UsrOperInqRsRec_CType is a complex
CType element.
Contains:
AccountId_CTypeCustomUsrOperInqRec_CTypereferencesCustom_CTypeOperFilterArray_AType
Simple Elements
The following simple elements are contained within this complex.
- CustId
- The identifier attached to a customer. It includes the OvrrdInstRtId attribute.
- Oper
- jXchange operations. Canonical Values are:
- AcctAnlysTrnAdd
- AcctAnlysTrnMod
- AcctInq
- AcctMod
- AcctReconItemMod
- ACHFltrAdd
- ACHFltrMod
- AddrAdd
- AddrMod
- CRMActAdd
- CRMActInq
- CRMActMod
- CRMActSrch
- CRMCustSrch
- CRMEventAdd
- CRMEventInq
- CRMEventMod
- CRMEventSrch
- CRMPotSaleSrch
- CRMProspAdd
- CRMProspInq
- CRMProspMod
- CRMProspSrch
- CRMReferAdd
- CRMReferInq
- CRMReferMod
- CRMReferSrch
- CustInq
- CustMod
- CustMsgAdd
- CustMsgMod
- DocImgAdd
- DocImgMod
- EFTCardAdd
- EFTCardInq
- EFTCardMod
- IntnetFinInstIdAdd
- IntnetFinInstIdInq
- IntnetFinInstIdMod
- IntnetFinInstIdPINMod
- StopChkAdd
- StopChkMod
TrnAdd- WireTrnAdd
- WireTrnInq
- WireTrnMod
- WorkflowInstcMod
- WorkflowInstcSrch
- WorkflowInstcStart
- XferAdd
- XferMod
- Rstr
- The level of restrictions that can exist at a parent and/or child
node. Canonical values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
AccountId_CType
AccountId_CType is a complex
CType element. This element contains the incoming account
identification information and any restrictions.
Simple Elements
The following simple elements are contained within this complex.
- AcctId
- The number or character that identifies an account record.
- AcctType
- The number or character that categorizes the AcctId.
- Rstr
- The level of restrictions that can exist at a parent and/or child
node. Canonical values are:
- Hid
- NoAccess
- NoAccessPart
- ReadOnly
- ReadOnlyPart
- ReadWrite
- ReadWritePart
CustomUsrOperInqRecComplex
Custom_CType is a complex CType element.
This element is optional.
CustomUsrOperInqRecComplex references
Custom_CType.
Custom_CType
Custom_CType is a complex CType element.
This element is optional.
OperFilterArray_AType
OperFilterArray_AType is an array
AType element. It is an array describing the applicable operation
filters.
Contains:
OperFilterInfo_CType
OperFilterInfo_CType
OperFilterInfo_CType is a complex
CType element.
Simple Elements
The following simple elements are contained within this complex.
- OperFilterType
- Operation filters. Canonical values are:
AcctModAcctType
AddrAddAddrCatUseAddrCat2Use
AddrModAddrCatUseAddrCat2Use
- CRMActAdd
- CRMActType
- CRMActInq
- CRMActType
- CRMActMod
- CRMActType
- CRMActSrch
- CRMActType
- CRMEventAdd
- CRMEventType
- CRMEventInq
- CRMEventType
- CRMEventMod
- CRMEventType
- CRMEventSrch
- CRMEventType
CustMsgAddMsgTypeAcctType
CustMsgModMsgTypeAcctType
StopChkAddAcctType
TrnAddBrCodeGLProdCodeGLCostCtr
XferAddXferTypeAcctType
XferModXferTypeAcctType
- OperFilterVal
- The operation filter value. Contains the Rstr attribute.