WSFederationAuthenticationModule.GetReturnUrlFromResponse Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Extracts the URL of the page that was originally requested from the sign-in response.
protected:
virtual System::String ^ GetReturnUrlFromResponse(System::Web::HttpRequestBase ^ request);protected virtual string GetReturnUrlFromResponse (System.Web.HttpRequestBase request);abstract member GetReturnUrlFromResponse : System.Web.HttpRequestBase -> string
override this.GetReturnUrlFromResponse : System.Web.HttpRequestBase -> stringProtected Overridable Function GetReturnUrlFromResponse (request As HttpRequestBase) As StringParameters
- request
- HttpRequestBase
The HTTP request that contains a form POST, which contains the WS-Federation sign-in response message.
Returns
The URL of the page that was originally requested by the client. This is the URL (at the relying party) to which the client should be redirected following successful sign-in.
Exceptions
request is null.
Remarks
This method is called from the request processing pipeline (the OnAuthenticateRequest method) to get the URL of the page at the relying party (RP) to direct the client to after successful sign-in. This is, typically, the URL of the RP resource to which the client originally requested access.
By default, WSFAM saves the return URL inside the wctx message parameter when it sends the WS-Federation sign-in request to the security token service (STS). In accordance with the WS-Federation specification, the wctx parameter is preserved across entities through which the message passes and is returned unaltered in the WS-Federation sign-in response message that is sent by the STS.
The default implementation gets the return URL from the wctx parameter in the sign-in response. For more information about the format of the wctx parameter that is used by WSFAM, see the CreateSignInRequest method.
