Login

This action launches the login process as defined in the Security Provider implementation.

It invokes the handleLogin function on the Security Provider with the returnPath argument.

This table describes the parameters for the Login action:

Parameter Name Description
returnPath The path of the page to go to after a successful login. If not defined, uses the default page of the application.
The behavior of the default implementation of the Security Provider handleLogin function is:

  • Navigate to the login URL specified by the Security Provider configuration.

  • If returnPath is not defined, use the default page of the application.

  • Convert the page returnPath to a URL path and add it to the login URL.

Here's an example of a call to the Login action: 

await Actions.login(context, {
        returnPath: '/loginpage',
      });