SessionSecurityTokenReceivedEventArgs Class

Reference

Definition

Namespace:: System.IdentityModel.Services

Assembly:: System.IdentityModel.Services.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides data for the SessionSecurityTokenReceived event.

public ref class SessionSecurityTokenReceivedEventArgs : System::ComponentModel::CancelEventArgs

public class SessionSecurityTokenReceivedEventArgs : System.ComponentModel.CancelEventArgs

type SessionSecurityTokenReceivedEventArgs = class
    inherit CancelEventArgs

Public Class SessionSecurityTokenReceivedEventArgs
Inherits CancelEventArgs

Inheritance: Object

EventArgs

CancelEventArgs
SessionSecurityTokenReceivedEventArgs

Remarks

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.

Constructors

SessionSecurityTokenReceivedEventArgs(SessionSecurityToken)

Initializes a new instance of the SecurityTokenReceivedEventArgs class that has the specified session token.

Properties

Cancel	Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs)
ReissueCookie	Gets or sets a value that specifies whether to reissue the session cookie with the response.
SessionToken	Gets or sets the session security token that was received.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to