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

The WindowsClaimsPrincipal class extends the WindowsPrincipal class to carry Claim information in addition to the identity information drawn from Windows security tokens.

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

Usage

'Usage
Dim instance As WindowsClaimsPrincipal

Syntax

'Declaration
<SerializableAttribute> _
Public Class WindowsClaimsPrincipal
    Inherits WindowsPrincipal
    Implements IClaimsPrincipal, IPrincipal, IDisposable

[SerializableAttribute] 
public class WindowsClaimsPrincipal : WindowsPrincipal, IClaimsPrincipal, IPrincipal, IDisposable

[SerializableAttribute] 
public ref class WindowsClaimsPrincipal : public WindowsPrincipal, IClaimsPrincipal, IPrincipal, IDisposable

/** @attribute SerializableAttribute() */ 
public class WindowsClaimsPrincipal extends WindowsPrincipal implements IClaimsPrincipal, IPrincipal, 
    IDisposable

SerializableAttribute 
public class WindowsClaimsPrincipal extends WindowsPrincipal implements IClaimsPrincipal, IPrincipal, 
    IDisposable

Remarks

In the claims model, multiple users or claims-based identities can be party to a single action. This class extends the WindowsPrincipal class to enable a Windows execution context to carry multiple claims-based identities (WindowsClaimsIdentity). WindowsClaimsPrincipal exposes a collection of identities, each of which implements IClaimsIdentity. 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.

Inheritance Hierarchy

System.Object
   System.Security.Principal.WindowsPrincipal
    Microsoft.IdentityModel.Claims.WindowsClaimsPrincipal

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

WindowsClaimsPrincipal Members
Microsoft.IdentityModel.Claims Namespace
IClaimsPrincipal Interface

Other Resources

What is Windows Identity Foundation?
Integration with IIdentity and IPrincipal

Copyright © 2008 by Microsoft Corporation. All rights reserved.