WSFederationAuthenticationModule.GetSecurityToken Method (SignInResponseMessage)

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Reads a security 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 SecurityToken GetSecurityToken(
	SignInResponseMessage message
)

Parameters

message
Type: System.IdentityModel.Services.SignInResponseMessage

The sign-in response message from which to read the token.

Return Value

Type: System.IdentityModel.Tokens.SecurityToken

The security token that was read from the message.

Exception Condition
ArgumentNullException

message is null.

The default implementation invokes the WSFederationAuthenticationModule.GetXmlTokenFromMessage(SignInResponseMessage, WSFederationSerializer) method to get the token and reads it by using the appropriate handler from the configured security token handlers.

.NET Framework
Available since 4.5
Return to top
Show: