ClaimsPrincipal Class

  • Article

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

Represents a claims-based principal object.

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

Usage

'Usage
Dim instance As ClaimsPrincipal

Syntax

'Declaration
<SerializableAttribute> _
Public Class ClaimsPrincipal
    Implements IClaimsPrincipal, IPrincipal

[SerializableAttribute] 
public class ClaimsPrincipal : IClaimsPrincipal, IPrincipal

[SerializableAttribute] 
public ref class ClaimsPrincipal : IClaimsPrincipal, IPrincipal

/** @attribute SerializableAttribute() */ 
public class ClaimsPrincipal implements IClaimsPrincipal, IPrincipal

SerializableAttribute 
public class ClaimsPrincipal implements IClaimsPrincipal, IPrincipal

Remarks

In the claims model, multiple users or claims-based identities can be party to a single action. The ClaimsPrincipal class exposes a collection of identities through the Identities property. Each of these identities implements the IClaimsIdentity interface and you can access the claims associated with the current caller through them. In the common case, there will be a single issuer and a single token and the identities collection will only have one element. However, it is possible in advanced scenarios for a relying party to ask (via policy) for more than one security token, potentially from different issuers. For more information about using claims-based principal objects in Windows® Identity Foundation (WIF), see the IClaimsPrincipal class.

Inheritance Hierarchy

System.Object
  Microsoft.IdentityModel.Claims.ClaimsPrincipal

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)

See Also

Reference

ClaimsPrincipal Members
Microsoft.IdentityModel.Claims Namespace
IClaimsPrincipal

Other Resources

What is Windows Identity Foundation?
Integration with IIdentity and IPrincipal

Copyright © 2008 by Microsoft Corporation. All rights reserved.