Saml2SecurityTokenHandler.ReadToken Method

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

Reads a SAML 2.0 token from the specified stream.

Namespace: Microsoft.IdentityModel.Tokens.Saml2
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)


Dim instance As Saml2SecurityTokenHandler
Dim reader As XmlReader
Dim returnValue As SecurityToken

returnValue = instance.ReadToken(reader)


Public Overrides Function ReadToken ( _
    reader As XmlReader _
) As SecurityToken
public override SecurityToken ReadToken (
    XmlReader reader
virtual SecurityToken^ ReadToken (
    XmlReader^ reader
) override
public SecurityToken ReadToken (
    XmlReader reader
public override function ReadToken (
    reader : XmlReader
) : SecurityToken


  • reader
    A XmlReader stream to a SAML 2.0 Security Token.

Return Value

An instance of Saml2SecurityToken.


Exception type Condition

The Configuration property is null.


The IssuerTokenResolver property of the configuration specified by the Configuration property is null.


The ServiceTokenResolver property of the configuration specified by the Configuration property 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.


Target Platforms

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

See Also


Saml2SecurityTokenHandler Class
Saml2SecurityTokenHandler Members
Microsoft.IdentityModel.Tokens.Saml2 Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.