SignOutRequestMessage Class

SignOutRequestMessage Class

.NET Framework (current version)
 

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)

System.Object
  System.IdentityModel.Services.FederationMessage
    System.IdentityModel.Services.WSFederationMessage
      System.IdentityModel.Services.SignOutRequestMessage

Public Class SignOutRequestMessage
	Inherits WSFederationMessage

NameDescription
System_CAPS_pubmethodSignOutRequestMessage(Uri)

Initializes a new instance of the SignOutRequestMessage class with the specified base URL.

System_CAPS_pubmethodSignOutRequestMessage(Uri, String)

Initializes a new instance of the SignOutRequestMessage class with the specified base URL and wreply parameter.

NameDescription
System_CAPS_pubpropertyAction

Gets or sets the wa parameter of the message.(Inherited from WSFederationMessage.)

System_CAPS_pubpropertyBaseUri

Gets or sets the base URL to which the message applies.(Inherited from FederationMessage.)

System_CAPS_pubpropertyContext

Gets or sets the wctx parameter of the message.(Inherited from WSFederationMessage.)

System_CAPS_pubpropertyEncoding

Gets or sets the wencoding parameter of the message.(Inherited from WSFederationMessage.)

System_CAPS_pubpropertyParameters

Gets the message parameters as a dictionary.(Inherited from FederationMessage.)

System_CAPS_pubpropertyReply

Gets or sets the wreply parameter of the message.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetParameter(String)

Returns the specified parameter value from the parameters dictionary.(Inherited from FederationMessage.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodRemoveParameter(String)

Removes a parameter from the parameters dictionary.(Inherited from FederationMessage.)

System_CAPS_pubmethodSetParameter(String, String)

Sets the value of a parameter in the parameters dictionary.(Inherited from FederationMessage.)

System_CAPS_pubmethodSetUriParameter(String, String)

Sets the value of a parameter in the parameters dictionary. The value must be an absolute URI.(Inherited from FederationMessage.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

System_CAPS_protmethodValidate()

Validates the current instance.(Overrides FederationMessage.Validate().)

System_CAPS_pubmethodWrite(TextWriter)

Writes the message in query string form to the specified text writer.(Overrides FederationMessage.Write(TextWriter).)

System_CAPS_pubmethodWriteFormPost()

Serializes the message as a form post and returns the resulting Form together with its Javascript as a string.(Inherited from FederationMessage.)

System_CAPS_pubmethodWriteQueryString()

Returns a string representation of the message in query-string format.(Inherited from FederationMessage.)

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
Available since 4.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft