The Login action is a System Action that logs a specified end-user in the system. The last login information is updated. All persistent roles are loaded with the respective grant or revoke. As an alternative, the User_Login action from the Users eSpace can be used.

The Login action clears all Session Variables to their default values when a different end-user logs in.

Input parameters

Identifier Type. Mandatory.

Boolean Type. Mandatory.

Output parameters


Possible exceptions

An invalid login exception might be raised when, for example, the end-user does not exist or it is not active.

Multi-Tenant Applications

When developing Multi-tenant applications you need to ensure that the session is bound to the correct tenant. Since the Login action runs in the scope of the current tenant, if the user does not exist in that tenant, the Login action fails.

To ensure the correct login process is performed, you need to:

  1. Design the business logic to obtain the tenant for the end-user;

  2. Use the TenantSwitch System action to bind the session to the obtained tenant;

  3. Use the Login action.

As an alternative you can use the User_Login action from the Users eSpace. This action automatically binds the session to the correct tenant. To use this action, you just need to ensure that end-users have unique names across all tenants.

See Also

Authenticating Users | Overview of System Actions and Functions