SecurityTokenHandler.CanValidateToken Property

.NET Framework (current version)

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

Gets a value that indicates whether the handler supports validation of security tokens.

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

public virtual bool CanValidateToken { get; }

Property Value

Type: System.Boolean

true if the class is capable of validating security tokens; otherwise, false. The default is false.

To implement validation in a derived class, override this property to return true and override the ValidateToken method to implement the validation logic.

The following code shows how to override the CanValidateToken property to indicate that a custom handler can validate tokens. The code is taken from the Custom Token sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). For information about this sample and other samples available for WIF and where to download them, see WIF Code Sample Index.

/// <summary>
/// Gets a value indicating whether this handler can validate tokens of type <see cref="SimpleWebToken"/>.
/// </summary>     
/// <value>True if this handler can validate the token of type <see cref="SimpleWebToken"/>.</value>
public override bool CanValidateToken
        return true;

.NET Framework
Available since 4.5
Return to top