Login.doLogin (Method)
Logs a specified user into CommonSpot.
Returns:
Login_DoLogin_Result (struct)
Each row of the returned query results has the following fields:
| Field Name | Type | Description |
|---|---|---|
| LoginResult | LoginResult | Result of attempting to log in. 0 = login failed, 1 = login succeeded, 2, login succeed but a password change is required. |
| SessionCookies | SessionCookies | Structure containing the possible session cookies, cfID, cfToken, and jSessionID. |
Arguments:
| Name | Type | Required | Description |
|---|---|---|---|
| userName | String | Required | The user name (i.e. ssmith) of the user logging in. |
| password | Password | Required | The user's password. |
Context:
| License Requirements | None |
| Permission Requirements | (none) |
| Deny Context | None |
| Require Context | None |
| Author Lock | (not required) |
| Transaction Logging | If transaction logging is enabled at the customer level, calls to this method will be logged |
| Customization | This method may be customized at the customer level |
Error Codes:
None
Notes:
None