Documentation Center

login

Logs the user into SDL LiveContent Reach application

Description

Validates a user name and password against the user database and grant's a user a permissions if successful. Permission to use various portions of SDL LiveContent Reach application and dependent on the groups the user belongs to.

Parameters

action
login
username
The user's identifying username, such as an email or nickname.
password
The user's secret password.
destination
If provided, the user will be redirected to this URL after a login attempt, regardless of whether the login is successful or not

Example URL

http://<host>:<port>/<context>/web/session.xql?action=login&username=<value>&password=<value>&destination=<value>

Successful Result

If successful, returns the session id as: <info name="sessionId" value="session#"/>

Failed Result

In the case of an error, this function returns a standard API result element with a non-zero statusCode (such as, <result status='FAIL' statusCode='200' message='Localized Failure Message' messageKey='message.key'/>). Refer to API Error Code Reference.