Saml2SecurityTokenHandler.CreateSecurityTokenReference 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 the security token reference when the token is not attached to the message.

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

Usage

'Usage
Dim instance As Saml2SecurityTokenHandler
Dim token As SecurityToken
Dim attached As Boolean
Dim returnValue As SecurityKeyIdentifierClause

returnValue = instance.CreateSecurityTokenReference(token, attached)

Syntax

'Declaration
Public Overrides Function CreateSecurityTokenReference ( _
    token As SecurityToken, _
    attached As Boolean _
) As SecurityKeyIdentifierClause

public override SecurityKeyIdentifierClause CreateSecurityTokenReference (
    SecurityToken token,
    bool attached
)

public:
virtual SecurityKeyIdentifierClause^ CreateSecurityTokenReference (
    SecurityToken^ token, 
    bool attached
) override

public SecurityKeyIdentifierClause CreateSecurityTokenReference (
    SecurityToken token, 
    boolean attached
)

public override function CreateSecurityTokenReference (
    token : SecurityToken, 
    attached : boolean
) : SecurityKeyIdentifierClause

Parameters

token
The SAML token.

attached
A value that indicates whether an attached or unattached reference should be created.

Return Value

A SecurityKeyIdentifierClause that represents the token reference. (An instance of Saml2AssertionKeyIdentifierClause is actually returned.)

Exceptions

Exception type	Condition
ArgumentNullException	token 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)