ClaimsPrincipal.CreateFromIdentity Method (IIdentity, String)

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

Creates the appropriate implementation of IClaimsPrincipal based on the type of the specified IIdentity object.

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

Usage

'Usage
Dim identity As IIdentity
Dim windowsIssuerName As String
Dim returnValue As IClaimsPrincipal

returnValue = ClaimsPrincipal.CreateFromIdentity(identity, windowsIssuerName)

Syntax

'Declaration
Public Shared Function CreateFromIdentity ( _
    identity As IIdentity, _
    windowsIssuerName As String _
) As IClaimsPrincipal
public static IClaimsPrincipal CreateFromIdentity (
    IIdentity identity,
    string windowsIssuerName
)
public:
static IClaimsPrincipal^ CreateFromIdentity (
    IIdentity^ identity, 
    String^ windowsIssuerName
)
public static IClaimsPrincipal CreateFromIdentity (
    IIdentity identity, 
    String windowsIssuerName
)
public static function CreateFromIdentity (
    identity : IIdentity, 
    windowsIssuerName : String
) : IClaimsPrincipal

Parameters

  • identity
    A IIdentity that represents the identity from which to create the principal.
  • windowsIssuerName
    The issuer name to use for Windows claims.

Return Value

An IClaimsPrincipal appropriate for the specified identity.

Exceptions

Exception type Condition
ArgumentNullException

identity is empty or null.

Remarks

The IClaimsPrincipal object that is returned is created based on the type of the IIdentity object specified by the identity parameter. For example, if the specified identity object is a WjndowsClaimsIdentity or is derived from WjndowsClaimsIdentity, or if it is a WindowsIdentity object or is based on or derived from WindowsIdentity, a WjndowsClaimsIdentity object is returned. The IClaimsIdentity associated with the created IClaimsPrincipal is generated based on the specified IIdentity as well.

Windows claims are associated with the issuer specified by windowsIssuerName.

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 Class
ClaimsPrincipal Members
Microsoft.IdentityModel.Claims Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.