Lets you sign a user in using a security token requested with WS-FederationPassive.
Namespace: Microsoft.IdentityModel.Web.Controls
Assembly: Microsoft.IdentityModel (in microsoft.identitymodel.dll)

Usage

Visual Basic
Dim instance As FederatedPassiveSignIn

Syntax

Visual Basic
<BindableAttribute(False)> _
<DefaultEventAttribute("SignedIn")> _
Public NotInheritable Class FederatedPassiveSignIn
		Inherits SignInControl
C#
[BindableAttribute(false)] 
[DefaultEventAttribute("SignedIn")] 
public sealed class FederatedPassiveSignIn : SignInControl
C++
[BindableAttribute(false)] 
[DefaultEventAttribute(L"SignedIn")] 
public ref class FederatedPassiveSignIn sealed : public SignInControl
J#
/** @attribute BindableAttribute(false) */ 
/** @attribute DefaultEventAttribute("SignedIn") */ 
public final class FederatedPassiveSignIn extends SignInControl
JScript
BindableAttribute(false) 
DefaultEventAttribute("SignedIn") 
public final class FederatedPassiveSignIn extends SignInControl

Remarks

The following code shows an example usage of this control:

  Copy Code
<idfx:FederatedPassiveSignIn
	AuthenticationType="https://www.contoso.com/authstrength1"
	ID="FederatedPassiveSignIn1"
	runat="Server" 
	Issuer="https://localhost/STS/default.aspx"
	SignInButtonType="Link"
	TitleText="Sign In"
	SignInText="Click here to sign in."
	Realm="https://localhost/RP/default.aspx"
	OnSignInError="FederatedPassiveSignIn1_SignInError" 
	DisplayRememberMe="false"
	VisibleWhenSignedIn="false">
</idfx:FederatedPassiveSignIn>
Note:
If you set AutoSignIn to true, be sure to set DestinationPageUrl to a different URL than your sign-in page. Otherwise, when a user successfully authenticates to an STS, his/her browser will go into an infinite redirection loop. This is because, if the user is redirected to the same page that originally sent him/her to the STS, the FederatedPassiveSignIn control sees that the current request is not a postback and does not contain a token, so it sends the user to the STS again.

If the SignInMode property is set to Session, the control calls Current to obtain the FAM, then calls SignIn. If that succeeds, the control redirects the user as follows. If the returnurl query string parameter exists, the control redirects the user to the URL specified there. Otherwise, if the DestinationPageUrl property is set, the control redirects the user to the URL specified there. Otherwise, the control redirects the user to the URL specified in FormAuthentication.DefaultUrl.

On any error, if the ErrorAction property is set to Refresh, the control simply stays on the current page. For RedirectToLoginPage, the control redirects the user to the URL specified in FormAuthentication.LoginUrl with the query string “?signinfailure=1”.

See Known Issues for more information on a known issue with the FederatedPassiveSignIn control and ASP.NET request validation.


Inheritance Hierarchy

System.Object
   System.Web.UI.Control
     System.Web.UI.WebControls.WebControl
       System.Web.UI.WebControls.CompositeControl
         Microsoft.IdentityModel.Web.Controls.SignInControl
          Microsoft.IdentityModel.Web.Controls.FederatedPassiveSignIn

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.

Platforms

Development Platforms

Windows Server 2003, Windows Vista

Target Platforms

Windows Server 2008, Windows Vista, Not tested on Windows XP

See Also