SessionAuthenticationModule.CreateSessionSecurityToken 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 a SessionSecurityToken using the configured handler.

Namespace: Microsoft.IdentityModel.Web
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim instance As SessionAuthenticationModule
Dim principal As IClaimsPrincipal
Dim context As String
Dim validFrom As DateTime
Dim validTo As DateTime
Dim isPersistent As Boolean
Dim returnValue As SessionSecurityToken

returnValue = instance.CreateSessionSecurityToken(principal, context, validFrom, validTo, isPersistent)

Syntax

'Declaration
Public Function CreateSessionSecurityToken ( _
    principal As IClaimsPrincipal, _
    context As String, _
    validFrom As DateTime, _
    validTo As DateTime, _
    isPersistent As Boolean _
) As SessionSecurityToken

public SessionSecurityToken CreateSessionSecurityToken (
    IClaimsPrincipal principal,
    string context,
    DateTime validFrom,
    DateTime validTo,
    bool isPersistent
)

public:
SessionSecurityToken^ CreateSessionSecurityToken (
    IClaimsPrincipal^ principal, 
    String^ context, 
    DateTime validFrom, 
    DateTime validTo, 
    bool isPersistent
)

public SessionSecurityToken CreateSessionSecurityToken (
    IClaimsPrincipal principal, 
    String context, 
    DateTime validFrom, 
    DateTime validTo, 
    boolean isPersistent
)

public function CreateSessionSecurityToken (
    principal : IClaimsPrincipal, 
    context : String, 
    validFrom : DateTime, 
    validTo : DateTime, 
    isPersistent : boolean
) : SessionSecurityToken

Parameters

principal
IClaimsPrincipal to be captured in the token.

context
An application defined context string.

validFrom
The first instant in which this token is valid.

validTo
The last instant in which this token is valid.

isPersistent
true if the value should be persisted by the user agent, otherwise false.

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)