krn.SessionLogin

This job logs a user into the active session. The user is identified by name and encrypted password.

For password encryption, please contact Optimal Systems GmbH.

1. Input Parameters

Name Type Required Description

Name	Type	Required	Description
`Flags`	INT	Yes	Currently not supported — pass `0`.
`UserName`	STRING	Yes	Login name of the user
`UserPwd`	STRING	Yes	Encrypted password
`[EntMgr]`	LONG	No	Only to be set at Enterprise Manager start.

Flags

INT

Yes

Currently not supported — pass 0.

UserName

STRING

Yes

UserPwd

STRING

Yes

Encrypted password

[EntMgr]

LONG

Only to be set at Enterprise Manager start.

2. Output Parameters

Name Type Dependency Description

Name	Type	Dependency	Description
`Description`	STRING	Optional	Description if an error occurs
`Action`	STRING	—	Action that was executed
`[UserGUID]`	STRING	Optional	GUID of the logged-in user (only for Enterprise Manager)
`[UserID]`	INT	Optional	ID of the logged-in user (only for Enterprise Manager)

Description

STRING

Optional

Description if an error occurs

Action

STRING

—

Action that was executed

[UserGUID]

STRING

Optional

GUID of the logged-in user (only for Enterprise Manager)

[UserID]

INT

Optional

ID of the logged-in user (only for Enterprise Manager)

3. Return Value

(INT): 0 = Job successful, otherwise error code.

The server reports a refused login as the collective code 1105265282 — identical for a wrong password, a manually locked account and one locked by failed logins. The cause is available in the error stack only (see Cause Codes in the Error Stack).

A wrong password counts towards the account’s lockout counter exactly as it does with krn.CheckUserAccount; for the sequence and for releasing a lock see Lockout Behaviour.