SignInRequestMessage Class

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

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.

Represents a WS-Federation Sign-In Request message.

public ref class SignInRequestMessage : System::IdentityModel::Services::WSFederationMessage

public class SignInRequestMessage : System.IdentityModel.Services.WSFederationMessage

type SignInRequestMessage = class
    inherit WSFederationMessage

Public Class SignInRequestMessage
Inherits WSFederationMessage

Inheritance: Object

FederationMessage

WSFederationMessage
SignInRequestMessage

Examples

string identityProviderUri = Request.QueryString["whr"];
string action = Request.QueryString["wa"];

SignInRequestMessage signInRequest = FederatedAuthentication.WSFederationAuthenticationModule.CreateSignInRequest(Guid.NewGuid().ToString(), 
                                                                                                                  "http://MyAppreturnUrl", 
                                                                                                                  false);
signInRequest.Realm = "htp://MyApp.com";
signInRequest.HomeRealm = identityProviderUri;

Response.Redirect(signInRequest.RequestUrl);

Remarks

A WS-Federation sign-in message is sent by a relying party (RP) to a security token service (STS) to request a security token. The wa parameter must be set to "wsignout1.0" and the wtrealm parameter should be set to the security realm of the requested resource (this is often the URL of the requested resource). Other optional parameters may also be specified in the request.

A SignOutRequestMessage message is created by the static methods of the SignOutRequestMessage class, for example the CreateFromUri method, when the wa parameter is set to "wsignin1.0", there is no wresult or wresultptr parameter present, and either a wtrealm parameter or a wreply parameter is present.

Important

For backward compatibility with Active Directory Federation Services (AD FS) version 1.0, Windows Identity Foundation (WIF) allows either the wtrealm parameter or the wreply parameter to be set (or both) for a sign-in message to be valid; however, the WS-Federation protocol requires that the wtrealm parameter be present in a sign-in request. In most scenarios, you should ensure that the wtrealm parameter is specified.

The SignInRequestMessage class exposes several properties that can be used to set or access individual message parameters. These parameters can also be set or accessed through the Parameters dictionary. For example, you can read the wtrealm parameter in the message either through the Realm property or by specifying "wtrealm" as the key to the Parameters dictionary.

For more information about the message that this class represents, see section 13 of the following specification: Web Services Federation Language (WS-Federation) Version 1.2.

Constructors

SignInRequestMessage(Uri, String)	Initializes a new instance of the SignInRequestMessage class with the specified base URL and wtrealm parameter.
SignInRequestMessage(Uri, String, String)	Initializes a new instance of the SignInRequestMessage class using the specified base URI, wtrealm parameter, and wreply parameter. Supports non-standard message creation for backward compatibility.

Properties

Action	Gets or sets the wa parameter of the message. (Inherited from WSFederationMessage)
AuthenticationType	Gets or sets the wauth parameter of the message.
BaseUri	Gets or sets the base URL to which the message applies. (Inherited from FederationMessage)
Context	Gets or sets the wctx parameter of the message. (Inherited from WSFederationMessage)
CurrentTime	Gets or sets the wct parameter of the message.
Encoding	Gets or sets the wencoding parameter of the message. (Inherited from WSFederationMessage)
Federation	Gets or sets the wfed parameter of the message.
Freshness	Gets or sets the wfresh parameter of the message.
HomeRealm	Gets or sets the whr parameter of the message.
Parameters	Gets the message parameters as a dictionary. (Inherited from FederationMessage)
Policy	Gets or sets the wp parameter of the message.
Realm	Gets or sets the wtrealm parameter of the message.
Reply	Gets or sets the wreply parameter of the message.
Request	Gets or sets the wreq parameter of the message.
RequestPtr	Gets or sets the wreqptr parameter of the message.
RequestUrl	Gets a string representation of the URL that corresponds to this message.
Resource	Gets or sets the wres parameter of the message.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetParameter(String)	Returns the specified parameter value from the parameters dictionary. (Inherited from FederationMessage)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
RemoveParameter(String)	Removes a parameter from the parameters dictionary. (Inherited from FederationMessage)
SetParameter(String, String)	Sets the value of a parameter in the parameters dictionary. (Inherited from FederationMessage)
SetUriParameter(String, String)	Sets the value of a parameter in the parameters dictionary. The value must be an absolute URI. (Inherited from FederationMessage)
ToString()	Returns a string that represents the current object. (Inherited from Object)
Validate()	Validates the current instance.
Write(TextWriter)	Writes this message in query string form to the specified text writer.
WriteFormPost()	Serializes the message as a form post and returns the resulting Form together with its Javascript as a string. (Inherited from FederationMessage)
WriteQueryString()	Returns a string representation of the message in query-string format. (Inherited from FederationMessage)

Applies to