WSFederationAuthenticationModule.SignInContext Property

.NET Framework (current version)

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

Gest or sets an application specific context value to be included in the wctx parameter in WS-Federation sign-in requests.

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

public string SignInContext { get; set; }

Property Value

Type: System.String

The application specific context value to be included in the wctx parameter for sign-in requests.

When the CreateSignInRequest method is invoked, the sign-in message that is generated contains a wctx parameter that has the following format: ru=returnUrl&cx=SignInContext&rm=rememberMeSet&id=uniqueId. The value of the SignInContext is stored in the cx parameter. CreateSignInRequest can be called directly from your code. It is also called when the WSFAM is performing passive redirects and also when either the SignIn method or the RedirectToIdentityProvider method is invoked by application code.

Although the WSFAM saves the SignInContext value in sign-in request messages, if the value is used by your application during response processing, you must provide the logic for extracting it from the wctx parameter in the sign-in response message.

For more information about the format and processing of the wctx parameter, see the CreateSignInRequest method.

.NET Framework
Available since 4.5
Return to top