Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
SessionSecurityTokenReceivedEventArgs Class
Collapse the table of content
Expand the table of content

SessionSecurityTokenReceivedEventArgs Class

.NET Framework 4.6 and 4.5

System.Object
  System.EventArgs
    System.ComponentModel.CancelEventArgs
      System.IdentityModel.Services.SessionSecurityTokenReceivedEventArgs

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

public class SessionSecurityTokenReceivedEventArgs : CancelEventArgs

The SessionSecurityTokenReceivedEventArgs type exposes the following members.

  NameDescription
Public methodSessionSecurityTokenReceivedEventArgsInitializes a new instance of the SecurityTokenReceivedEventArgs class that has the specified session token.
Top

  NameDescription
Public propertyCancelGets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs.)
Public propertyReissueCookieGets or sets a value that specifies whether to reissue the session cookie with the response.
Public propertySessionTokenGets or sets the session security token that was received.
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, the SessionSecurityTokenReceived event is raised from within the SessionAuthenticationModule.OnAuthenticateRequest method after a session token (SessionSecurityToken) has been successfully read from the session cookie. In the event handler, you can modify properties of the session token before it is passed further along the pipeline and is used to authenticate the entity making the request (user).

You can access the token through the SessionToken property. After modifying the token, you can ensure that it is written back to the cookie by setting the ReissueCookie to true. Finally, the SessionSecurityTokenReceived event is a cancelable event, and you can set the Cancel property (inherited from CancelEventArgs) to abort further processing of the request.

.NET Framework

Supported in: 4.6, 4.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2015 Microsoft