User login
|
XML name |
base:UserLoginRequest |
|
Class name |
de.lobster.scm.base.authentication.UserLoginRequest |
The UserLoginRequest can be used both via REST and via Lobster_data expansions.
<base:UserLoginRequest xmlns:base='SCM.BASE' userName="jabend" password="jabend123!" selectedRole="2" selectedCompany="2" locale="de" clientType="Custom Rest Client" forceLogin="true" />The login takes place under indication of the user name (userName) and its password (password).
Should the user not exist or the password is wrong, an exception is raised and the login fails.
If the user is assigned to several companies or roles (see Users), the company and role that are to be used must be indicated.
|
Parameter |
Required? |
Description |
Example |
userName |
|
The user name to be used for login. |
userName="jabend" |
password |
|
The user name's password |
password="jabend123!" |
selectedRole |
|
The ID of the role to be used. This parameter is necessary only if the user is assigned to several roles. |
selectedRole="2" |
selectedCompany |
|
The ID of the company to be used. This parameter is necessary only if the user is assigned to several companies. |
selectedCompany="2" |
locale |
|
Here, the language set for the user can be overwritten for this session. |
locale="de" |
clientType |
|
The client type. The flex client used here is e.g. 'Flex'. Note that for every client type and user, only one simultaneous login is permitted. |
clientType="Custom Rest Client" |
forceLogin |
|
If 'true', a possibly existing session is logged off for this user with this client type. If forceLogin='false' and a session already exists, an exception is raised. |
forceLogin="true" |
