Edit

Share via


WSFederationAuthenticationModule.SignInContext Property

Definition

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

public:
 property System::String ^ SignInContext { System::String ^ get(); void set(System::String ^ value); };
public string SignInContext { get; set; }
member this.SignInContext : string with get, set
Public Property SignInContext As String

Property Value

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

Remarks

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.

Applies to

See also