WSFederationAuthenticationModule.GetXmlTokenFromMessage Method

Definition

Namespace:

System.IdentityModel.Services

Assembly:

System.IdentityModel.Services.dll

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

Overloads

GetXmlTokenFromMessage(SignInResponseMessage)	Extracts the issued token from the specified WS-Federation sign-in response message.
GetXmlTokenFromMessage(SignInResponseMessage, WSFederationSerializer)	Extracts the issued token from the specified WS-Federation sign-in response message by using the specified WS-Federation serializer.

GetXmlTokenFromMessage(SignInResponseMessage)

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

public:
 virtual System::String ^ GetXmlTokenFromMessage(System::IdentityModel::Services::SignInResponseMessage ^ message);

public virtual string GetXmlTokenFromMessage (System.IdentityModel.Services.SignInResponseMessage message);

abstract member GetXmlTokenFromMessage : System.IdentityModel.Services.SignInResponseMessage -> string
override this.GetXmlTokenFromMessage : System.IdentityModel.Services.SignInResponseMessage -> string

Public Overridable Function GetXmlTokenFromMessage (message As SignInResponseMessage) As String

Parameters

message

SignInResponseMessage

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

Returns

String

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

Exceptions

ArgumentNullException

message is null.

InvalidOperationException

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

Remarks

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.

GetXmlTokenFromMessage(SignInResponseMessage, WSFederationSerializer)

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

public:
 virtual System::String ^ GetXmlTokenFromMessage(System::IdentityModel::Services::SignInResponseMessage ^ message, System::IdentityModel::Services::WSFederationSerializer ^ federationSerializer);

public virtual string GetXmlTokenFromMessage (System.IdentityModel.Services.SignInResponseMessage message, System.IdentityModel.Services.WSFederationSerializer federationSerializer);

abstract member GetXmlTokenFromMessage : System.IdentityModel.Services.SignInResponseMessage * System.IdentityModel.Services.WSFederationSerializer -> string
override this.GetXmlTokenFromMessage : System.IdentityModel.Services.SignInResponseMessage * System.IdentityModel.Services.WSFederationSerializer -> string

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

Parameters

message

SignInResponseMessage

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

federationSerializer

WSFederationSerializer

The WS-Federation serializer to use to de-serialize the sign-in response message.

Returns

String

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

Exceptions

ArgumentNullException

message is null.