Saml11SecurityTokenHandler.ValidateToken Method

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

Validates a given token and returns a SubjectCollection.

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

Usage

'Usage
Dim instance As Saml11SecurityTokenHandler
Dim token As SecurityToken
Dim returnValue As ClaimsIdentityCollection

returnValue = instance.ValidateToken(token)

Syntax

'Declaration
Public Overrides Function ValidateToken ( _
    token As SecurityToken _
) As ClaimsIdentityCollection

public override ClaimsIdentityCollection ValidateToken (
    SecurityToken token
)

public:
virtual ClaimsIdentityCollection^ ValidateToken (
    SecurityToken^ token
) override

public ClaimsIdentityCollection ValidateToken (
    SecurityToken token
)

public override function ValidateToken (
    token : SecurityToken
) : ClaimsIdentityCollection

Parameters

token
The token to be validated.

Return Value

ClaimsIdentityCollection containing the ClaimsIdentities extracted from the given token.

Exceptions

Exception type	Condition
ArgumentNullException	The input argument 'token' is null.
ArgumentException	The input argument 'token' can not be cast 'as a' SamlSecurityToken. -or- SamlSecurityToken.Assertion is null.
InvalidOperationException	If AudienceUri are to be checked and none are found in the token.
SecurityTokenException	If AudienceUri are to be checked and a match is not found.
SecurityTokenValidationException	May be thrown if the certificate associated with the token issuer does not pass validation.
CryptographicException	May be thrown if the certificate associated with the token issuer does not pass validation.

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)