LoginResponse Object
Contains information returned as a result of logging in.
This object is used by the following operations:
The properties included in the LoginResponse object are listed below.
Property | Type | Description |
---|---|---|
authToken | string | The authToken for the user, indicating that the user's credentials have passed validation. |
pendingNotifications | integer | The number of notifications pending for the user. |
userName | string | The username. By default this is FirstnameLastname, but the user can change it. |
userFDN | string | The user's FDN; the unique UserID for this user. |
Status | string |
Indicates the status of the login attempt. Success indicates a successful login. In the response to the POST /api/login operation, you can ignore this value. |
AvatarURL | anyURI |
URL for the avatar uploaded for the resource, if any. Used only in response messages. If no avatar is specified, it is the URL for the default user avatar. |
loginDomainID | string | The unique ID for the user's login domain. For local platform users, the value is siteusers.{tenant-id}. Example: siteusers.acmepaymentscorp. Other login domains, such as Google and Facebook, have different IDs. |
pendingTasks[ ] | string |
If applicable, an array of one or more pending tasks that must be completed before login is complete. Possible values:
|
pendingTaskData | string | Information about any pending tasks. |
loginState | string |
Indicates where in the login process the user currently is. Valid values:
See also: Login State. |
pending agreements[ ] | string | Indicates the agreement that the user must accept to complete the login process, if applicable. |
csrfToken | string | The CSRF token for the logged-in user, if applicable. |
sessionValidUntil | dateTime |
This property is used to determine how long the session will be valid if the session remains active (active sesion timeout), if active session timeout is set up in the Community Manager developer portal. If active session timeout is not set, authTokenValidUntil is not present in the response. If it is present, the user’s session will be invalid after the timestamp, even if the token is renewed. The Community Manager developer portal uses this value to determine when to end the user's sesssion. This property is constructed using login time and active session timeout value. |
authTokenValidUntil | dateTime |
How long the session will be valid. This property is used to determine the active session timeout, if active session timeout is set in the Community Manager developer portal. If active session timeout is not set, authTokenValidUntil is not present in the response. If it is present, the user’s session will be invalid after the timestamp, even if the token is renewed. The Community Manager developer portal uses this value to determine when to end the user's session. For more information on how session timeout works, see Session Time / Session Timeout. |