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

Returns the SamlSubject to use for all the statements that will be created. Overwrite this method to customize the creation of the SamlSubject.

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

Usage

'Usage
Dim tokenDescriptor As SecurityTokenDescriptor
Dim returnValue As SamlSubject

returnValue = Me.CreateSamlSubject(tokenDescriptor)

Syntax

'Declaration
Protected Overridable Function CreateSamlSubject ( _
    tokenDescriptor As SecurityTokenDescriptor _
) As SamlSubject

protected virtual SamlSubject CreateSamlSubject (
    SecurityTokenDescriptor tokenDescriptor
)

protected:
virtual SamlSubject^ CreateSamlSubject (
    SecurityTokenDescriptor^ tokenDescriptor
)

protected SamlSubject CreateSamlSubject (
    SecurityTokenDescriptor tokenDescriptor
)

protected function CreateSamlSubject (
    tokenDescriptor : SecurityTokenDescriptor
) : SamlSubject

Parameters

tokenDescriptor
Contains all the information that is used in token issuance.

Return Value

A SamlSubject created from the first subject found in the tokenDescriptor as follows:1. Claim of Type NameIdentifier is searched. If found, SamlSubject.Name is set to claim.Value. 2. If a non-null tokenDescriptor.proof is found then SamlSubject.KeyIdentifier = tokenDescriptor.Proof.KeyIdentifier AND SamlSubject.ConfirmationMethod is set to 'HolderOfKey'. 3. If a null tokenDescriptor.proof is found then SamlSubject.ConfirmationMethod is set to 'BearerKey'.

Exceptions

Exception type	Condition
ArgumentNullException	Thrown when 'tokenDescriptor' is null.

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)