GetSessionTokenContext Method

WSFederationAuthenticationModule.GetSessionTokenContext Method ()

.NET Framework 4.6 and 4.5

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

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

protected virtual string GetSessionTokenContext()

Return Value

Type: System.String

The string to persist in the session cookie.

Exception Condition

The Issuer property is null.

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.

.NET Framework
Available since 4.5
Return to top
© 2015 Microsoft