LoginResponse Data Type

Type that provides a response to a login attempt. Successful attempts return a SUCCESS flag and message and echo the username. Failed attempts return a FAILURE flag and a message that describes the reason for failing.

Abstract Type
Properties
name data type description
loginResult LoginResult
message string
userInfo UserInfo

Example

This data type is abstract. The example below may be incomplete. More accurate examples can be found in subtypes pages.
{
  "loginResult" : "FAILURE",
  "message" : "...",
  "userInfo" : {
    "username" : "...",
    "displayName" : "..."
  }
}