WindowsClaimsPrincipal.Identity 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 the user associated with this principal.

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

Usage

'Usage
Dim instance As WindowsClaimsPrincipal
Dim value As IIdentity

value = instance.Identity

Syntax

'Declaration
Public Overrides ReadOnly Property Identity As IIdentity

public override IIdentity Identity { get; }

public:
virtual property IIdentity^ Identity {
    IIdentity^ get () override;
}

/** @property */
public IIdentity get_Identity ()

public override function get Identity () : IIdentity

Property Value

The IIdentity that represents the Windows identity (user) for this principal.

Exceptions

Exception type	Condition
InvalidOperationException	The Identities property does not contain a WindowsClaimsIdentity.

Remarks

This property returns a WindowsClaimsIdentity from the identity objects associated with this principal. The identity objects can be accessed from the Identities property. If there is no WindowsClaimsIdentity associated with this principal, the InvalidOperationException exception is thrown.

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)

Share via