WSFederationAuthenticationModule.GetXmlTokenFromMessage Method (SignInResponseMessage, WSFederationSerializer)

Article
10/05/2012

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Extract the issued token from the WS-Federation Passive Protocol SignIn Response message received from an STS.

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As WSFederationAuthenticationModule
Dim message As SignInResponseMessage
Dim federationSerializer As WSFederationSerializer
Dim returnValue As String

returnValue = instance.GetXmlTokenFromMessage(message, federationSerializer)

Syntax

'Declaration
Public Overridable Function GetXmlTokenFromMessage ( _
    message As SignInResponseMessage, _
    federationSerializer As WSFederationSerializer _
) As String

public virtual string GetXmlTokenFromMessage (
    SignInResponseMessage message,
    WSFederationSerializer federationSerializer
)

public:
virtual String^ GetXmlTokenFromMessage (
    SignInResponseMessage^ message, 
    WSFederationSerializer^ federationSerializer
)

public String GetXmlTokenFromMessage (
    SignInResponseMessage message, 
    WSFederationSerializer federationSerializer
)

public function GetXmlTokenFromMessage (
    message : SignInResponseMessage, 
    federationSerializer : WSFederationSerializer
) : String

Parameters

message
The HTTP request at the FederatedAuthenticationModule. This request contains the token issued by the STS in a WS-Federation Passive Protocol SignIn Response message from the STS.

federationSerializer
The WS-Federation Serializer used to de-serialize the WS-Federation Passive Protocol SignIn Response message.

Return Value

The issued token as an XML String.

Exceptions

Exception type	Condition
ArgumentNullException	One of the parameters is null.

Thread Safety

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

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)

Share via