WSFederationAuthenticationModule.CanReadSignInResponse Method (HttpRequest)

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.]

Determines if request is a WS-Federation Passive Protocol SignIn Response message from the STS.

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

Usage

'Usage
Dim instance As WSFederationAuthenticationModule
Dim request As HttpRequest
Dim returnValue As Boolean

returnValue = instance.CanReadSignInResponse(request)

Syntax

'Declaration
Public Function CanReadSignInResponse ( _
    request As HttpRequest _
) As Boolean

public bool CanReadSignInResponse (
    HttpRequest request
)

public:
bool CanReadSignInResponse (
    HttpRequest^ request
)

public boolean CanReadSignInResponse (
    HttpRequest request
)

public function CanReadSignInResponse (
    request : HttpRequest
) : boolean

Parameters

request
The incoming HTTP request.

Return Value

Performs protocol processing including SignOuts and Redirects rather than simply returning a Boolean.

Remarks

Extend the functionality provided by this method to perform additional validation for whether an incoming request is a WS-Federation Passive Protocol SignIn Response message.

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)