WSFederationAuthenticationModule.RedirectToIdentityProvider Method

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Redirect user to identity provider STS for obtaining a token using WS-Federation Passive Protocol.

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As WSFederationAuthenticationModule
Dim uniqueId As String
Dim returnUrl As String
Dim persist As Boolean

instance.RedirectToIdentityProvider(uniqueId, returnUrl, persist)

Syntax

'Declaration
Public Overridable Sub RedirectToIdentityProvider ( _
    uniqueId As String, _
    returnUrl As String, _
    persist As Boolean _
)

public virtual void RedirectToIdentityProvider (
    string uniqueId,
    string returnUrl,
    bool persist
)

public:
virtual void RedirectToIdentityProvider (
    String^ uniqueId, 
    String^ returnUrl, 
    bool persist
)

public void RedirectToIdentityProvider (
    String uniqueId, 
    String returnUrl, 
    boolean persist
)

public function RedirectToIdentityProvider (
    uniqueId : String, 
    returnUrl : String, 
    persist : boolean
)

Parameters

uniqueId
Identifier of control that is signing in.

returnUrl
URL to return to upon authentication.

persist
True if context cookie should be persistent.

Exceptions

Exception type	Condition
InvalidOperationException	The Issuer or Realm property is null or empty, or HttpContext.Current or HttpContext.Current.Response is null.

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

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)