UserNameSecurityTokenHandler.RetainPassword Property

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

Controls if the password will be retained in the bootstrap token that is attached to the ClaimsIdentity in ValidateToken. The default is false.

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


Dim instance As UserNameSecurityTokenHandler
Dim value As Boolean

value = instance.RetainPassword

instance.RetainPassword = value


Public Overridable Property RetainPassword As Boolean
public virtual bool RetainPassword { get; set; }
virtual property bool RetainPassword {
    bool get ();
    void set (bool value);
/** @property */
public boolean get_RetainPassword ()

/** @property */
public void set_RetainPassword (boolean value)
public function get RetainPassword () : boolean

public function set RetainPassword (value : boolean)

Property Value

Returns Boolean.

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


UserNameSecurityTokenHandler Class
UserNameSecurityTokenHandler Members
Microsoft.IdentityModel.Tokens Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.