ClaimsPrincipal.CreateFromIdentities Method (ClaimsIdentityCollection, String)

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

Creates an appropriate IClaimsPrincipal object from a collection of claims-based identities.

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

Usage

'Usage
Dim identities As ClaimsIdentityCollection
Dim windowsIssuerName As String
Dim returnValue As IClaimsPrincipal

returnValue = ClaimsPrincipal.CreateFromIdentities(identities, windowsIssuerName)

Syntax

'Declaration
Public Shared Function CreateFromIdentities ( _
    identities As ClaimsIdentityCollection, _
    windowsIssuerName As String _
) As IClaimsPrincipal

public static IClaimsPrincipal CreateFromIdentities (
    ClaimsIdentityCollection identities,
    string windowsIssuerName
)

public:
static IClaimsPrincipal^ CreateFromIdentities (
    ClaimsIdentityCollection^ identities, 
    String^ windowsIssuerName
)

public static IClaimsPrincipal CreateFromIdentities (
    ClaimsIdentityCollection identities, 
    String windowsIssuerName
)

public static function CreateFromIdentities (
    identities : ClaimsIdentityCollection, 
    windowsIssuerName : String
) : IClaimsPrincipal

Parameters

identities
A ClaimsIdentityCollection that contains the identities.

windowsIssuerName
The issuer name to use for Windows claims.

Return Value

An IClaimsPrincipal appropriate for the identities in the collection.

Exceptions

Exception type	Condition
ArgumentNullException	identities is empty or null.

Remarks

If there is an identity based on a WindowsIdentity in the ClaimsIdentityCollection, a WindowsClaimsPrincipal is returned. The issuer specified by windowsIssuerName is used for Windows claims.

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)