Export (0) Print
Expand All

WSFederationAuthenticationModule.GetXmlTokenFromMessage Method (SignInResponseMessage)

.NET Framework 4.5

Extracts the issued token from the specified WS-Federation sign-in response message.

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

public virtual string GetXmlTokenFromMessage(
	SignInResponseMessage message
)

Parameters

message
Type: System.IdentityModel.Services.SignInResponseMessage

The sign-in response message to extract the token from. The sign-in response contains the token issued by the STS.

Return Value

Type: System.String
A string that contains the XML that represents the issued token. This is a <wst:RequestSecurityTokenResponse> element.

ExceptionCondition
ArgumentNullException

message is null.

InvalidOperationException

message does not contain a token. (It does not contain a valid wresult or wresultptr parameter.)

If there is no wresult parameter in the sign-in response message, the GetReferencedResult method is called to try to get the token using the wresultptr parameter.

.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.

Show:
© 2014 Microsoft