SDK: Custom Login Page

Overview

The SDK allows users to customize Designer Elements. It also allows users to modify the default Portal login Page with custom styles and designs. Users can integrate the login page according to their preferences, allowing them to incorporate SAML, OpenID, or any other desired authentication method. For more information, refer to Software Development Kit (SDK) Overview.

Prerequisite:

• Create a Module with SDK
• Download the pre-built module below referenced in this article:
  Decisions.CustomLogin.Web(1).zip

Configuration

1. Navigate to the SDK Examples on Github to check out the Decisions.CustomLogin.Example project.
2. Open folder Decisions.CustomLogin.Web and open the Decisions.CustomLogin.web.csproj in an IDE.
3. Navigate to Decisions.CustomLogin.Example/Decisions.CustomLogin.Web/Controllers and open CustomLoginController.cs. This login controller example includes the following:

   using Decisions.Web.Core.CustomLogin;
   using Decisions.Web.Core.Models;
   using Microsoft.AspNetCore.Authorization;
   using Microsoft.AspNetCore.Mvc;
   
   namespace Decisions.UnitTests.Web.Core.Controllers
   {
       public class CustomLoginController : Controller, ICustomLoginPageProvider
       {
           public string LoginLayoutPath { get => "~/VIEWS/CUSTOMLOGIN/CUSTOMLOGINLAYOUT.CSHTML"; set { } }
   
           [AllowAnonymous]
           public IActionResult RedirectToCustomLogin(LoginViewModel loginViewModel)
           {
               return View("CustomLogin", loginViewModel);
           }
       }
   }

   1. The login controller must extend Controller and implement CustomerLoginPageProvider.
   2. The String variable LoginLayoutPath refers to the customized login page layout file CustomLoginLayout.cshtml that is created under the Views folder.
   3. The RedirectToCustomLogin method directs the user to the custom-styled page CustomLogin.cshtml in the Views folder. This method triggers when the user logs out or navigates to log into the environment.
4. Navigate to [Custom Login Module Example]\Decisions.CustomLogin.Example\Decisions.CustomLogin.Web\ and open the Module.Build.xml file. This file includes references to two MVC .dlls: the project and Views.
   
5. Below is how the Custom Login Page example will be displayed to a user logging in.

Important Considerations

When using a custom layout in CustomLogin.cshtml, there are a couple of mandatory sections that need to be rendered or ignored.

To Render:

@RenderSection("loginmodal", false)

@RenderSection("loginfooter", false)

To Ignore it:

@{

    IgnoreSection("loginfooter");

    IgnoreSection("loginmodal");

}