Saml2SecurityTokenHandler.CreateClaims Method

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 claims from a SAML 2.0 token.

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

Usage

'Usage
Dim samlToken As Saml2SecurityToken
Dim returnValue As IClaimsIdentity

returnValue = Me.CreateClaims(samlToken)

Syntax

'Declaration
Protected Overridable Function CreateClaims ( _
    samlToken As Saml2SecurityToken _
) As IClaimsIdentity

protected virtual IClaimsIdentity CreateClaims (
    Saml2SecurityToken samlToken
)

protected:
virtual IClaimsIdentity^ CreateClaims (
    Saml2SecurityToken^ samlToken
)

protected IClaimsIdentity CreateClaims (
    Saml2SecurityToken samlToken
)

protected function CreateClaims (
    samlToken : Saml2SecurityToken
) : IClaimsIdentity

Parameters

samlToken
A Saml2SecurityToken that represents the security token from which to create the claims.

Return Value

An IClaimsIdentity that contains the claims extracted from the token.

Exceptions

Exception type	Condition
ArgumentNullException	samlToken is null.
ArgumentException	The Assertion property of samlToken is null.
InvalidOperationException	The handler is not configured or an issuer name registry is not configured for the handler. (The Configuration property is null or is set to a SecurityTokenHandlerConfiguration with an IssuerNameRegistry property that is null.
SecurityTokenException	The issuer name returned by the configured issuer name registry for the security token (samlToken) is null or empty.

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)