WindowsClaimsIdentity.CreateFromUpn Method (String, String, Boolean, 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 a new instance of the WindowsClaimsIdentity class using a Kerberos User Principal Name (UPN) and the specified issuer.

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

Usage

'Usage
Dim upn As String
Dim authenticationType As String
Dim useWindowsTokenService As Boolean
Dim issuerName As String
Dim returnValue As WindowsClaimsIdentity

returnValue = WindowsClaimsIdentity.CreateFromUpn(upn, authenticationType, useWindowsTokenService, issuerName)

Syntax

'Declaration
Public Shared Function CreateFromUpn ( _
    upn As String, _
    authenticationType As String, _
    useWindowsTokenService As Boolean, _
    issuerName As String _
) As WindowsClaimsIdentity

public static WindowsClaimsIdentity CreateFromUpn (
    string upn,
    string authenticationType,
    bool useWindowsTokenService,
    string issuerName
)

public:
static WindowsClaimsIdentity^ CreateFromUpn (
    String^ upn, 
    String^ authenticationType, 
    bool useWindowsTokenService, 
    String^ issuerName
)

public static WindowsClaimsIdentity CreateFromUpn (
    String upn, 
    String authenticationType, 
    boolean useWindowsTokenService, 
    String issuerName
)

public static function CreateFromUpn (
    upn : String, 
    authenticationType : String, 
    useWindowsTokenService : boolean, 
    issuerName : String
) : WindowsClaimsIdentity

Parameters

• upn
  The Kerberos UPN of the user that this WindowsClaimsIdentity represents.

• authenticationType
  The type of authentication used.

• useWindowsTokenService
  true to indicate that the Windows Token Service is to be used for this operation.

• issuerName
  The name of the issuer to use for the claims associated with the WindowsClaimsIdentity.

Return Value

A WindowsClaimsIdentity.

Remarks

If configured, the Windows Token Service will be utilized to ensure that this WindowsClaimsIdentity allows impersonation. The Issuer property of the user’s claims will be set to issuerName.

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

WindowsClaimsIdentity Class
WindowsClaimsIdentity Members
Microsoft.IdentityModel.Claims Namespace

Other Resources

Claims to Windows Token Service (c2WTS) Overview

Copyright © 2008 by Microsoft Corporation. All rights reserved.