UserNameSecurityTokenHandler Members

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

Defines a SecurityTokenHandler for Username Password Tokens.

The following tables list the members exposed by the UserNameSecurityTokenHandler type.

Protected Constructors

  Name Description
  UserNameSecurityTokenHandler Initializes an instance of UserNameSecurityTokenHandler


Public Properties

  Name Description
public property CanValidateToken  Indicates whether this handler supports validation of tokens handled by this instance. (Inherited from SecurityTokenHandler)
public property CanWriteToken Overridden. Returns true to indicate that the handler can write UsernameSecurityToken.
public property Configuration  Gets or sets the SecurityTokenHandlerConfiguration (Inherited from SecurityTokenHandler)
public property ContainingCollection  Gets or sets the SecurityTokenHandlerCollection that this SecurityTokenHandler is part of. This property should never be set directly. When the SecurityTokenHandler is added to a collection this property is automatically set. (Inherited from SecurityTokenHandler)
public property RetainPassword Controls if the password will be retained in the bootstrap token that is attached to the ClaimsIdentity in ValidateToken. The default is false.
public property TokenType Overridden. Get the System.Type of the SecurityToken that this handler can handle.


Public Methods

(see also Protected Methods)

  Name Description
public method CanReadKeyIdentifierClause  Indicates if the current XML element is pointing to a KeyIdentifierClause that can be serialized by this instance. (Inherited from SecurityTokenHandler)
public method CanReadToken Overridden. Checks the given XmlReader to verify that it is pointing to a Username token.
public method CanWriteKeyIdentifierClause  Indicates if the given SecurityKeyIdentifierClause can be serialized by this instance. (Inherited from SecurityTokenHandler)
public method CreateSecurityTokenReference  Create the security token reference for tokens handled by this instance. (Inherited from SecurityTokenHandler)
public method CreateToken  Called by the STS to create a token given a token descriptor. (Inherited from SecurityTokenHandler)
public method Equals  (Inherited from Object)
public method GetHashCode  (Inherited from Object)
public method GetTokenTypeIdentifiers Overridden. Get the TokenTypeIdentifier of the token that this handler can work with.
public method GetType  (Inherited from Object)
public method ReadKeyIdentifierClause  Deserializes the XML to a KeyIdentifierClause that references a token handled by this instance. (Inherited from SecurityTokenHandler)
public method ReadToken  Overloaded. (Inherited from SecurityTokenHandler)
public method ReadToken Overridden. Reads the UsernameSecurityToken from the given XmlReader.
public method ToString  (Inherited from Object)
public method ValidateToken  (Inherited from SecurityTokenHandler)
public method WriteKeyIdentifierClause  Serializes to XML a SecurityKeyIdentifierClause that this instance supports. (Inherited from SecurityTokenHandler)
public method WriteToken Overridden. Writes the given UsernameSecurityToken to the XmlWriter.


Protected Methods

  Name Description
protected method DetectReplayedTokens  Throws if a token is detected as being replayed. Override this method in your derived class to detect replays. (Inherited from SecurityTokenHandler)
protected method Finalize  (Inherited from Object)
protected method MemberwiseClone  (Inherited from Object)


See Also


UserNameSecurityTokenHandler Class
Microsoft.IdentityModel.Tokens Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.