Class LoginPlugin

A plugin that is executed on the login page.

Inheritance

System.Object

Plugin

LoginPlugin

PostLoginPlugin

PreLoginPlugin

Inherited Members

Plugin.RequestFactory

Plugin.SessionVariables

Plugin.SystemSettings

Plugin.Cookies

Plugin.Environment

Plugin.CreateObjRef(Type)

Namespace: Softadmin.Api.Login

Assembly: Softadmin.Api.dll

Syntax

public abstract class LoginPlugin : Plugin

Properties

ForwardState

Gets or sets an object that controls where the user is forwarded after logging in.

Declaration

public IForwardState ForwardState { get; set; }

Property Value

Type	Description
IForwardState

Remarks

Test IsReadOnly before modifying it.

HttpHeaders

Gets or sets the HTTP headers passed to the login page.

Declaration

public IHttpHeaders HttpHeaders { get; set; }

Property Value

Type	Description
IHttpHeaders

QueryString

Gets or sets the login page's query string parameters.

Declaration

public IParameters QueryString { get; set; }

Property Value

Type	Description
IParameters

UserPrincipal

Gets or sets the user's principal.

Declaration

public IPrincipal UserPrincipal { get; set; }

Property Value

Type	Description
IPrincipal

Remarks

The type of principal returned depends on the IIS authentication modules enabled. For Windows Authentication UserPrincipal.Identity.Name will be on the form "DOMAIN\Username".