SignOutRequestMessage Class

.NET Framework 4.5

Represents a WS-Federation sign-out message. This message is created when the received message has the action parameter (wa) set to “wsignout1.0”.

Namespace:  System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

public class SignOutRequestMessage : WSFederationMessage

The SignOutRequestMessage type exposes the following members.

  NameDescription
Public methodSignOutRequestMessage(Uri)Initializes a new instance of the SignOutRequestMessage class with the specified base URL.
Public methodSignOutRequestMessage(Uri, String)Initializes a new instance of the SignOutRequestMessage class with the specified base URL and wreply parameter.
Top

  NameDescription
Public propertyActionGets or sets the wa parameter of the message. (Inherited from WSFederationMessage.)
Public propertyBaseUriGets or sets the base URL to which the message applies. (Inherited from FederationMessage.)
Public propertyContextGets or sets the wctx parameter of the message. (Inherited from WSFederationMessage.)
Public propertyEncodingGets or sets the wencoding parameter of the message. (Inherited from WSFederationMessage.)
Public propertyParametersGets the message parameters as a dictionary. (Inherited from FederationMessage.)
Public propertyReplyGets or sets the wreply parameter of the message.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetParameterReturns the specified parameter value from the parameters dictionary. (Inherited from FederationMessage.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRemoveParameterRemoves a parameter from the parameters dictionary. (Inherited from FederationMessage.)
Public methodSetParameterSets the value of a parameter in the parameters dictionary. (Inherited from FederationMessage.)
Public methodSetUriParameterSets the value of a parameter in the parameters dictionary. The value must be an absolute URI. (Inherited from FederationMessage.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Protected methodValidateValidates the current instance. (Overrides FederationMessage.Validate().)
Public methodWriteWrites the message in query string form to the specified text writer. (Overrides FederationMessage.Write(TextWriter).)
Public methodWriteFormPostSerializes the message as a form post and returns the resulting Form together with its Javascript as a string. (Inherited from FederationMessage.)
Public methodWriteQueryStringReturns a string representation of the message in query-string format. (Inherited from FederationMessage.)
Top

A WS-Federation sign-out message is sent by a relying party (RP) to a security token service (STS) to sign out of the current session with that STS. The wa parameter must be set to “wsignout1.0” and an optional wreply parameter may be set to indicate the URL to which the client should be redirected by the STS after sign-out completes.

A SignOutRequestMessage message is created by the static methods of the WSFederationMessage class, for example the CreateFromUri method, when the wa parameter is set to “wsignout1.0”.

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 (http://go.microsoft.com/fwlink/?LinkID=210152).

.NET Framework

Supported in: 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft