This topic has not yet been rated - Rate this topic

SessionSecurityTokenCreatedEventArgs Class

.NET Framework 4.5

System.Object
  System.EventArgs
    System.IdentityModel.Services.SessionSecurityTokenCreatedEventArgs

Namespace:  System.IdentityModel.Services
Assembly:  System.IdentityModel.Services (in System.IdentityModel.Services.dll)
'Declaration
Public Class SessionSecurityTokenCreatedEventArgs _
	Inherits EventArgs

The SessionSecurityTokenCreatedEventArgs type exposes the following members.

  NameDescription
Public methodSessionSecurityTokenCreatedEventArgsInitializes a new instance of the SessionSecurityTokenCreatedEventArgs class by using the specified session security token.
Top
  NameDescription
Public propertySessionTokenGets or sets the session security token that was created.
Public propertyWriteSessionCookieGets or sets a value that indicates whether a cookie should be written in the response.
Top
  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

By default:

  • In the session authentication module (SAM) the SessionSecurityTokenCreated event is raised from within the SessionAuthenticationModule.OnAuthenticateRequest method after a session token (SessionSecurityToken) has been created. This happens, for example, if an event handler for the SessionSecurityTokenReceived event modifies the token. You can use the SessionSecurityTokenCreatedEventArgs to modify the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user).

  • In the WS-Federation authentication module (WSFAM), the SessionSecurityTokenCreated event is raised from the request processing pipeline just after a session token has been created from the WS-Federation sign-in response message received from the STS and just before the SAM is called to set the thread principal and write the session cookie.

You can use the SessionToken property to modify or replace the token. You can set the WriteSessionCookie to specify whether the session cookie should be written (or re-written).

.NET Framework

Supported in: 4.5.1, 4.5

Windows Phone 8.1, Windows Phone 8, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.