SessionAuthenticationModule.CreateSessionSecurityToken Method

.NET Framework 4.5

Creates a SessionSecurityToken from the specified parameters by using the configured session token handler.

Namespace:  System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)

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

Parameters

principal
Type: System.Security.Claims.ClaimsPrincipal

The principal to be captured in the token.

context
Type: System.String

An application-defined context string.

validFrom
Type: System.DateTime

The first instant in which this token is valid.

validTo
Type: System.DateTime

The last instant in which this token is valid.

isPersistent
Type: System.Boolean

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

Return Value

Type: System.IdentityModel.Tokens.SessionSecurityToken
The session token.

ExceptionCondition
InvalidOperationException

There is not a valid session token handler configured. (There is no SessionSecurityTokenHandler configured in the SecurityTokenHandlers property.)

.NET Framework

Supported in: 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft