Saml11SecurityTokenHandler.FindUpn Method

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

Finds the UPN claim value in the provided IClaimsIdentity object for the purpose of mapping the identity to a WindowsClaimsIdentity object.

Namespace: Microsoft.IdentityModel.Tokens.Saml11
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim claimsIdentity As IClaimsIdentity
Dim returnValue As String

returnValue = Me.FindUpn(claimsIdentity)

Syntax

'Declaration
Protected Overridable Function FindUpn ( _
    claimsIdentity As IClaimsIdentity _
) As String
protected virtual string FindUpn (
    IClaimsIdentity claimsIdentity
)
protected:
virtual String^ FindUpn (
    IClaimsIdentity^ claimsIdentity
)
protected String FindUpn (
    IClaimsIdentity claimsIdentity
)
protected function FindUpn (
    claimsIdentity : IClaimsIdentity
) : String

Parameters

  • claimsIdentity
    The claims identity object containing the desired UPN claim.

Return Value

The UPN claim value found.

Exceptions

Exception type Condition
InvalidOperationException

If more than one UPN claim is contained in claimsIdentity

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

Saml11SecurityTokenHandler Class
Saml11SecurityTokenHandler Members
Microsoft.IdentityModel.Tokens.Saml11 Namespace

Copyright © 2008 by Microsoft Corporation. All rights reserved.