WSFederationAuthenticationModule.CanReadSignInResponse Method

  • Reference

Definition

Namespace:
System.IdentityModel.Services
Assembly:
System.IdentityModel.Services.dll

Returns a value that indicates whether the specified HTTP request is a WS-Federation sign-in response message. If the message is a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"), this method processes the request.

Overloads

CanReadSignInResponse(HttpRequestBase)

Returns a value that indicates whether the specified HTTP request is a WS-Federation sign-in response message. If the message is a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"), this method processes the request.
CanReadSignInResponse(HttpRequestBase, Boolean)

Returns a value that indicates whether the specified HTTP request is a WS-Federation sign-in response message. If the message is a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"), this method processes the request.

Remarks

A sign-in response message is sent to the relying party (RP) by a security token service (STS) in response to a sign-in request message.

CanReadSignInResponse(HttpRequestBase)

Returns a value that indicates whether the specified HTTP request is a WS-Federation sign-in response message. If the message is a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"), this method processes the request.

public:
 bool CanReadSignInResponse(System::Web::HttpRequestBase ^ request);
public bool CanReadSignInResponse (System.Web.HttpRequestBase request);
member this.CanReadSignInResponse : System.Web.HttpRequestBase -> bool
Public Function CanReadSignInResponse (request As HttpRequestBase) As Boolean

Parameters

request
HttpRequestBase

The incoming HTTP request.

Returns

Boolean

true if the specified HTTP request contains a form POST in which the wa parameter is set to "wsignout1.0" and the wresult parameter is not empty; otherwise, false.

Exceptions

ArgumentNullException

request is null.

Remarks

This method is invoked from the request processing pipeline to determine whether the incoming HTTP request is a FORM post that contains a WS-Federation sign-in response message.

It invokes the WSFederationAuthenticationModule.CanReadSignInResponse(HttpRequestBase, Boolean) overload with the onPage parameter set false to indicate that the call did not originate while processing a page.

See also

Applies to

CanReadSignInResponse(HttpRequestBase, Boolean)

Returns a value that indicates whether the specified HTTP request is a WS-Federation sign-in response message. If the message is a WS-Federation sign-out clean-up message ("wsignoutcleanup1.0"), this method processes the request.

public:
 virtual bool CanReadSignInResponse(System::Web::HttpRequestBase ^ request, bool onPage);
public virtual bool CanReadSignInResponse (System.Web.HttpRequestBase request, bool onPage);
abstract member CanReadSignInResponse : System.Web.HttpRequestBase * bool -> bool
override this.CanReadSignInResponse : System.Web.HttpRequestBase * bool -> bool
Public Overridable Function CanReadSignInResponse (request As HttpRequestBase, onPage As Boolean) As Boolean

Parameters

request
HttpRequestBase

The incoming HTTP request.

onPage
Boolean

true if the call originates while processing a page request. false if the caller is an HTTP module. This parameter determines how to terminate processing or send redirects if the incoming message is a WS-Federation sign-out cleanup message ("wsignoutcleanup1.0").

Returns

Boolean

true if the specified HTTP request contains a FORM post in which the wa parameter is set to "wsignout1.0" and the wresult parameter is not empty; otherwise, false.

Exceptions

ArgumentNullException

request is null.

Remarks

This method is invoked from the request processing pipeline through the WSFederationAuthenticationModule.CanReadSignInResponse(HttpRequestBase) overload to determine whether the incoming HTTP request is a form POST that contains a WS-Federation sign-in response message.

The default implementation performs the following:

  • If the incoming request is a form POST, it calls the IsSignInResponse method to determine whether the form POST contains a sign-in response.

  • If the incoming request is not a form POST, and the request contains a WS-Federation sign-out clean-up request (the wa parameter is "wsignoutcleanup1.0"), sign-out clean-up is performed. In this case, the WSFederationAuthenticationModule.SignOut(Boolean) method is invoked (with the parameter set to true to indicate a sign-out clean-up) to sign out of the session. This also causes the sign-out events to be raised.

    Next, if the sign-out clean-up request contains a wreply parameter, the client is redirected to the URL returned by the GetSignOutRedirectUrl method; otherwise, an image of a green check mark is returned to the STS. The receipt of this image can be used by the STS as a confirmation that the sign-out clean-up request was received and successfully processed by the RP.

See also

Applies to