SecurityTokenReceivedEventArgs Class

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

public class SecurityTokenReceivedEventArgs : CancelEventArgs

NameDescription
System_CAPS_pubmethodSecurityTokenReceivedEventArgs(SecurityToken)

Initializes a new instance of the SecurityTokenReceivedEventArgs class by using the specified security token.

System_CAPS_pubmethodSecurityTokenReceivedEventArgs(SecurityToken, String)

Initializes a new instance of the SecurityTokenReceivedEventArgs class by using the specified security token and sign-in context.

NameDescription
System_CAPS_pubpropertyCancel

Gets or sets a value indicating whether the event should be canceled.(Inherited from CancelEventArgs.)

System_CAPS_pubpropertySecurityToken

Gets or sets the issued security token.

System_CAPS_pubpropertySignInContext

Gets the sign-in context specified in the control.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

The event is raised when an issued token is received from the security token service (STS) during sign-in using WS-Federation. It is raised before the token is validated. You can access the issued token through the SecurityToken property and modify its properties or replace it. You can cancel sign-in processing by setting the Cancel property.

.NET Framework
Available since 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.

Return to top
Show: