Saml11SecurityTokenHandler.CreateAttributeStatement 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 SamlAttributeStatements and adds them to a collection. Override this method to provide a custom implementation.Default behavior is to create a new SamlAttributeStatement for each Subject in the tokenDescriptor.Subjects collection.

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

Usage

'Usage
Dim samlSubject As SamlSubject
Dim subject As IClaimsIdentity
Dim tokenDescriptor As SecurityTokenDescriptor
Dim returnValue As SamlAttributeStatement

returnValue = Me.CreateAttributeStatement(samlSubject, subject, tokenDescriptor)

Syntax

'Declaration
Protected Overridable Function CreateAttributeStatement ( _
    samlSubject As SamlSubject, _
    subject As IClaimsIdentity, _
    tokenDescriptor As SecurityTokenDescriptor _
) As SamlAttributeStatement

protected virtual SamlAttributeStatement CreateAttributeStatement (
    SamlSubject samlSubject,
    IClaimsIdentity subject,
    SecurityTokenDescriptor tokenDescriptor
)

protected:
virtual SamlAttributeStatement^ CreateAttributeStatement (
    SamlSubject^ samlSubject, 
    IClaimsIdentity^ subject, 
    SecurityTokenDescriptor^ tokenDescriptor
)

protected SamlAttributeStatement CreateAttributeStatement (
    SamlSubject samlSubject, 
    IClaimsIdentity subject, 
    SecurityTokenDescriptor tokenDescriptor
)

protected function CreateAttributeStatement (
    samlSubject : SamlSubject, 
    subject : IClaimsIdentity, 
    tokenDescriptor : SecurityTokenDescriptor
) : SamlAttributeStatement

Parameters

samlSubject
The SamlSubject to use in the SamlAttributeStatement that are created.

subject
The ClaimsIdentity that contains claims which will be converted to SAML Attributes.

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

Return Value

SamlAttributeStatement

Exceptions

Exception type	Condition
ArgumentNullException	Thrown when 'samlSubject' 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)