LSAuthenticationObject Class

 

Allows web forms (like clientlogon.aspx) to interact with the Federation Service or Federation Service Proxy on which they are running.

Namespace:   System.Web.Security.SingleSignOn
Assembly:  System.Web.Security.SingleSignOn (in System.Web.Security.SingleSignOn.dll)

Inheritance Hierarchy

System.Object
  System.Web.Security.SingleSignOn.LSAuthenticationObject

Syntax

public class LSAuthenticationObject

public ref class LSAuthenticationObject 

type LSAuthenticationObject = class end

Public Class LSAuthenticationObject

Properties

	Name	Description
	Current	Gets the LSAuthenticationObject for the current request, if applicable. The property will return null if an appropriate LSAuthenticationObject cannot be located.
	FormContext	Gets information about the type of action that is required of the Web form that is being invoked and queries for any additional data needed to perform that action.

Methods

	Name	Description
	BeginLogonClient(ClientCredentialInfo, AsyncCallback, Object)	Logs on a client asynchronously. This method should be called by an asynchronous logon form when it has collected credentials, generally from the Begin asynchronous handler for OnPreRenderComplete.
	BeginLogonClient(WindowsIdentity, AsyncCallback, Object)	Logs on a client asynchronously. This method should be called by an asynchronous logon form when it has collected credentials, generally from the Begin asynchronous handler for OnPreRenderComplete.
	EndLogonClient(IAsyncResult)	Retrieves the result of logging on a client asynchronously. This method should be called by an asynchronous logon form when it has collected credentials, generally from the End asynchronous handler for OnPreRenderComplete.
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	InitiateBasicAuthentication()	Initiates basic authentication. This method should be called by the logon form when it wishes to perform basic authentication. Typically this is done when username/password credentials are desired and IsClientNonInteractive is true.
	IssueResourceToken()	Issues a resource token. This method should be called by the policy enforcement form to indicate that the policy has been enforced and the Federation Service should issue a token.
	LogonClient(ClientCredentialInfo)	Logs on a client. This method should be called by the logon form when it has collected credentials.
	LogonClient(WindowsIdentity)	Logs on a client. This method should be called by the logon form when it has collected credentials.
	MemberwiseClone()	(Inherited from Object.)
	RedirectToAccountFederationPartner(String)	Redirects the client to an account partner for authentication. This method should be called by the discovery form when a user's home realm has been determined.
	ToString()	(Inherited from Object.)

Remarks

The programming model for an AD FS web form should be to call LSAuthenticationObject. Current to get the LSAuthenticationObject for the current request, then to check the FormContext property to see what action is being performed and retrieve any data needed to perform that action.

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

System.Web.Security.SingleSignOn Namespace

Return to top