IClaimsIdentity.NameClaimType Property

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

Gets or sets the claim type to be used for the Name property.

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

Usage

'Usage
Dim instance As IClaimsIdentity
Dim value As String

value = instance.NameClaimType

instance.NameClaimType = value

Syntax

'Declaration
Property NameClaimType As String

string NameClaimType { get; set; }

property String^ NameClaimType {
    String^ get ();
    void set (String^ value);
}

/** @property */
String get_NameClaimType ()

/** @property */
void set_NameClaimType (String value)

function get NameClaimType () : String

function set NameClaimType (value : String)

Property Value

The claim type to be used to determine the name of this identity. This is typically a URI.

Remarks

The Name property returns the name of the identity (subject). The claims-based model extends this property to use claims associated with the identity object to determine the name. The NameClaimType specifies the claim type that should be used to provide the name of the subject; for example, one of the constants specified by ClaimTypes.

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)