S3. Method Result Data Fields
The table below shows the Data Fields that XDOC expects to be returned.
- The fields marked as Required are only required if the user object is being returned.
- The Result related fields (ResultCode, ResultMessage, ResultTrace) are usually only used if authentication fails, or some other error occurs and the External System wants to provide additional information to XDOC on the reason for failure. E.g.: Invalid Password, User does not exist, internal exception, etc.
|UserName||String||Yes||Should be the same as the input UserName.|
|Profile||String||Yes*||User’s default Role in the Integrated Application. * Can actually be empty, but usually is should be set.|
|ExternalId||String||Yes||Unique Identifier of the user in the External System.|
|ExternalData||String||Arbitrary data about the user from the External System. Passed through to the all Container Provider and other Integrated Application method invocations.|
|ExternalFlags||Long||Arbitrary bit-mask of flags from the External System. Passed through to the all Container Provider and other Integrated Application method invocations.|
|Success||Bool||Indicates success or failure.|
|ResultCode||String||Internal Result Code. Usually only used for error conditions.|
|ResultMessage||String||User friendly message. E.g.: Invalid Password.|
|ResponseTrace||String||Error Stack Trace or debug information.|