Edit

WSFederationAuthenticationModule.GetSessionTokenContext Method

  • Reference

Definition

Namespace:
System.IdentityModel.Services
Assembly:
System.IdentityModel.Services.dll

Gets a string that should be persisted with the session cookie in the Context property.

protected:
 virtual System::String ^ GetSessionTokenContext();
protected virtual string GetSessionTokenContext ();
abstract member GetSessionTokenContext : unit -> string
override this.GetSessionTokenContext : unit -> string
Protected Overridable Function GetSessionTokenContext () As String

Returns

String

The string to persist in the session cookie.

Exceptions

ArgumentNullException

The Issuer property is null.

Remarks

The GetSessionTokenContext method is called from the request processing pipeline when processing a WS-Federation sign-in response message to get the value to store in the SessionSecurityToken.Context property inside the session cookie.

You can override this method to provide an application-specific value to be stored in the cookie. WSFAM does not expose any methods to retrieve the value from the cookie. You must provide the logic in your application to read the value back from the cookie if it is needed.

Applies to

See also